From fd4d99f3bb83cc2b7e3798bc985876d30c229c3e Mon Sep 17 00:00:00 2001 From: AWS SDK For Ruby Date: Thu, 18 Jan 2024 19:13:32 +0000 Subject: [PATCH] Updated API models and rebuilt service gems. --- apis/b2bi/2022-06-23/api-2.json | 11 +- apis/b2bi/2022-06-23/docs-2.json | 2 +- apis/b2bi/2022-06-23/examples-1.json | 709 ++++++++++++++++++ apis/cloudtrail/2013-11-01/api-2.json | 93 +++ apis/cloudtrail/2013-11-01/docs-2.json | 98 ++- apis/cloudtrail/2013-11-01/paginators-1.json | 5 + apis/connect/2017-08-08/api-2.json | 2 +- apis/connect/2017-08-08/docs-2.json | 10 +- apis/drs/2020-02-26/api-2.json | 4 + apis/firehose/2015-08-04/api-2.json | 192 ++++- apis/firehose/2015-08-04/docs-2.json | 160 +++- .../2020-07-01/api-2.json | 2 +- .../2020-07-01/docs-2.json | 2 +- .../2020-07-01/endpoint-rule-set-1.json | 40 +- gems/aws-partitions/CHANGELOG.md | 5 + gems/aws-partitions/VERSION | 2 +- gems/aws-partitions/partitions.json | 6 + gems/aws-sdk-b2bi/CHANGELOG.md | 5 + gems/aws-sdk-b2bi/VERSION | 2 +- gems/aws-sdk-b2bi/lib/aws-sdk-b2bi.rb | 2 +- gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb | 702 ++++++++++++++++- .../lib/aws-sdk-b2bi/client_api.rb | 3 + gems/aws-sdk-cloudtrail/CHANGELOG.md | 5 + gems/aws-sdk-cloudtrail/VERSION | 2 +- .../lib/aws-sdk-cloudtrail.rb | 2 +- .../lib/aws-sdk-cloudtrail/client.rb | 178 ++++- .../lib/aws-sdk-cloudtrail/client_api.rb | 54 ++ .../lib/aws-sdk-cloudtrail/endpoints.rb | 14 + .../aws-sdk-cloudtrail/plugins/endpoints.rb | 2 + .../lib/aws-sdk-cloudtrail/types.rb | 444 ++++++++--- gems/aws-sdk-connect/CHANGELOG.md | 5 + gems/aws-sdk-connect/VERSION | 2 +- gems/aws-sdk-connect/lib/aws-sdk-connect.rb | 2 +- .../lib/aws-sdk-connect/client.rb | 35 +- .../lib/aws-sdk-connect/types.rb | 33 +- gems/aws-sdk-drs/CHANGELOG.md | 5 + gems/aws-sdk-drs/VERSION | 2 +- gems/aws-sdk-drs/lib/aws-sdk-drs.rb | 2 +- gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb | 2 +- gems/aws-sdk-firehose/CHANGELOG.md | 5 + gems/aws-sdk-firehose/VERSION | 2 +- gems/aws-sdk-firehose/lib/aws-sdk-firehose.rb | 2 +- .../lib/aws-sdk-firehose/client.rb | 170 ++++- .../lib/aws-sdk-firehose/client_api.rb | 90 +++ .../lib/aws-sdk-firehose/types.rb | 467 +++++++++++- .../CHANGELOG.md | 5 + .../VERSION | 2 +- .../aws-sdk-sagemakerfeaturestoreruntime.rb | 2 +- .../client.rb | 22 +- .../endpoint_provider.rb | 2 +- 50 files changed, 3419 insertions(+), 196 deletions(-) diff --git a/apis/b2bi/2022-06-23/api-2.json b/apis/b2bi/2022-06-23/api-2.json index 228411dcff8..f938b77b3cc 100644 --- a/apis/b2bi/2022-06-23/api-2.json +++ b/apis/b2bi/2022-06-23/api-2.json @@ -282,7 +282,8 @@ "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ] }, "ListTransformers":{ @@ -321,7 +322,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ] }, "TestMapping":{ @@ -367,7 +369,8 @@ "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "idempotent":true }, @@ -1226,7 +1229,7 @@ }, "TestMappingInputFileContent":{ "type":"string", - "max":200000, + "max":5000000, "min":0 }, "TestMappingRequest":{ diff --git a/apis/b2bi/2022-06-23/docs-2.json b/apis/b2bi/2022-06-23/docs-2.json index 113746464ed..d2d75908315 100644 --- a/apis/b2bi/2022-06-23/docs-2.json +++ b/apis/b2bi/2022-06-23/docs-2.json @@ -23,7 +23,7 @@ "StartTransformerJob": "

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.

", "TagResource": "

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.

", "TestMapping": "

Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.

", - "TestParsing": "

Parses the input EDI (electronic data interchange) file.

", + "TestParsing": "

Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.

", "UntagResource": "

Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.

", "UpdateCapability": "

Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

", "UpdatePartnership": "

Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

", diff --git a/apis/b2bi/2022-06-23/examples-1.json b/apis/b2bi/2022-06-23/examples-1.json index 0ea7e3b0bbe..b3238951f22 100644 --- a/apis/b2bi/2022-06-23/examples-1.json +++ b/apis/b2bi/2022-06-23/examples-1.json @@ -1,5 +1,714 @@ { "version": "1.0", "examples": { + "CreateCapability": [ + { + "input": { + "name": "b2biexample", + "type": "edi", + "clientToken": "foo", + "configuration": { + "edi": { + "type": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "inputLocation": { + "key": "input/", + "bucketName": "test-bucket" + }, + "outputLocation": { + "key": "output/", + "bucketName": "test-bucket" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "instructionsDocuments": [ + { + "key": "instructiondoc.txt", + "bucketName": "test-bucket" + } + ], + "tags": [ + { + "Key": "capabilityKey1", + "Value": "capabilityValue1" + } + ] + }, + "output": { + "name": "b2biexample", + "type": "edi", + "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + "capabilityId": "ca-963a8121e4fc4e348", + "configuration": { + "edi": { + "type": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "inputLocation": { + "key": "input/", + "bucketName": "test-bucket" + }, + "outputLocation": { + "key": "output/", + "bucketName": "test-bucket" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "createdAt": "2023-11-01T21:51:05.504Z", + "instructionsDocuments": [ + { + "key": "instructiondoc.txt", + "bucketName": "test-bucket" + } + ] + }, + "id": "example-1", + "title": "Sample CreateCapability call" + } + ], + "CreatePartnership": [ + { + "input": { + "name": "b2bipartner", + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "clientToken": "foo", + "email": "john@example.com", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tags": [ + { + "Key": "sampleKey1", + "Value": "sampleValue1" + } + ] + }, + "output": { + "name": "b2bipartner", + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", + "partnershipId": "ps-219fa02f5b4242af8", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + }, + "id": "example-1", + "title": "Sample CreatePartnership call" + } + ], + "CreateProfile": [ + { + "input": { + "name": "Shipping Profile", + "businessName": "John's Shipping", + "clientToken": "foo", + "email": "john@example.com", + "logging": "ENABLED", + "phone": "5555555555", + "tags": [ + { + "Key": "sampleKey", + "Value": "sampleValue" + } + ] + }, + "output": { + "name": "Shipping Profile", + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "logging": "ENABLED", + "phone": "5555555555", + "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "profileId": "p-60fbc37c87f04fce9" + }, + "id": "example-1", + "title": "Sample CreateProfile call" + } + ], + "CreateTransformer": [ + { + "input": { + "name": "transformJSON", + "clientToken": "foo", + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "{}", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "tags": [ + { + "Key": "sampleKey", + "Value": "sampleValue" + } + ] + }, + "output": { + "name": "transformJSON", + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", + "transformerId": "tr-974c129999f84d8c9" + }, + "id": "example-1", + "title": "Sample CreateTransformer call" + } + ], + "DeleteCapability": [ + { + "input": { + "capabilityId": "ca-963a8121e4fc4e348" + }, + "id": "example-1", + "title": "Sample DeleteCapabilty call" + } + ], + "DeletePartnership": [ + { + "input": { + "partnershipId": "ps-219fa02f5b4242af8" + }, + "id": "example-1", + "title": "Sample DeletePartnership call" + } + ], + "DeleteProfile": [ + { + "input": { + "profileId": "p-60fbc37c87f04fce9" + }, + "id": "example-1", + "title": "Sample DeleteProfile call" + } + ], + "DeleteTransformer": [ + { + "input": { + "transformerId": "tr-974c129999f84d8c9" + }, + "id": "example-1", + "title": "Sample DeleteTransformer call" + } + ], + "GetCapability": [ + { + "input": { + "capabilityId": "ca-963a8121e4fc4e348" + }, + "output": { + "name": "b2biexample", + "type": "edi", + "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + "capabilityId": "ca-963a8121e4fc4e348", + "configuration": { + "edi": { + "type": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "inputLocation": { + "key": "input/", + "bucketName": "test-bucket" + }, + "outputLocation": { + "key": "output/", + "bucketName": "test-bucket" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "createdAt": "2023-11-01T21:51:05.504Z", + "instructionsDocuments": [ + { + "key": "instructiondoc.txt", + "bucketName": "test-bucket" + } + ], + "modifiedAt": "2023-11-02T21:51:05.504Z" + }, + "id": "example-1", + "title": "Sample GetCapabilty call" + } + ], + "GetPartnership": [ + { + "input": { + "partnershipId": "ps-219fa02f5b4242af8" + }, + "output": { + "name": "b2bipartner", + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8", + "partnershipId": "ps-219fa02f5b4242af8", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + }, + "id": "example-1", + "title": "Sample GetPartnership call" + } + ], + "GetProfile": [ + { + "input": { + "profileId": "p-60fbc37c87f04fce9" + }, + "output": { + "name": "Shipping Profile", + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "logging": "ENABLED", + "phone": "5555555555", + "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "profileId": "p-60fbc37c87f04fce9" + }, + "id": "example-1", + "title": "Sample GetProfile call" + } + ], + "GetTransformer": [ + { + "input": { + "transformerId": "tr-974c129999f84d8c9" + }, + "output": { + "name": "transformJSON", + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", + "transformerId": "tr-974c129999f84d8c9" + }, + "id": "example-1", + "title": "Sample GetTransformer call" + } + ], + "GetTransformerJob": [ + { + "input": { + "transformerId": "tr-974c129999f84d8c9", + "transformerJobId": "tj-vpYxfV7yQOqjMSYllEslLw" + }, + "output": { + "message": "Transformed, writing output", + "outputFiles": [ + { + "key": "output/sample-214.edi.2023-11-01T10:44:03.353Z.json", + "bucketName": "gt-edi-test" + } + ], + "status": "succeeded" + }, + "id": "example-1", + "title": "Sample GetTransformerJob call" + } + ], + "ListCapabilities": [ + { + "input": { + "maxResults": 50, + "nextToken": "foo" + }, + "output": { + "capabilities": [ + { + "name": "b2biexample", + "type": "edi", + "capabilityId": "ca-963a8121e4fc4e348", + "createdAt": "2023-11-01T21:51:05.504Z", + "modifiedAt": "2023-11-01T21:51:05.504Z" + } + ], + "nextToken": "foo" + }, + "id": "example-1", + "title": "Sample ListCapabilities call" + } + ], + "ListPartnerships": [ + { + "input": { + "maxResults": 50, + "nextToken": "foo", + "profileId": "p-60fbc37c87f04fce9" + }, + "output": { + "nextToken": "string", + "partnerships": [ + { + "name": "b2bipartner", + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "partnershipId": "ps-219fa02f5b4242af8", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + } + ] + }, + "id": "example-1", + "title": "Sample ListPartnerships call" + } + ], + "ListProfiles": [ + { + "input": { + "maxResults": 50, + "nextToken": "foo" + }, + "output": { + "nextToken": "foo", + "profiles": [ + { + "name": "Shipping Profile", + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "logging": "ENABLED", + "profileId": "p-60fbc37c87f04fce9" + } + ] + }, + "id": "example-1", + "title": "Sample ListProfiles call" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9" + }, + "output": { + "Tags": [ + { + "Key": "sampleKey", + "Value": "SampleValue" + } + ] + }, + "id": "example-1", + "title": "Sample ListTagsForResources call" + } + ], + "ListTransformers": [ + { + "input": { + "maxResults": 50, + "nextToken": "foo" + }, + "output": { + "nextToken": "foo", + "transformers": [ + { + "name": "transformJSON", + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerId": "tr-974c129999f84d8c9" + } + ] + }, + "id": "example-1", + "title": "Sample ListTransformers call" + } + ], + "StartTransformerJob": [ + { + "input": { + "clientToken": "foo", + "inputFile": { + "key": "input/inputFile.txt", + "bucketName": "test-bucket" + }, + "outputLocation": { + "key": "output/", + "bucketName": "test-bucket" + }, + "transformerId": "tr-974c129999f84d8c9" + }, + "output": { + "transformerJobId": "tj-vpYxfV7yQOqjMSYllEslLw" + }, + "id": "example-1", + "title": "Sample StartTransformerJob call" + } + ], + "TagResource": [ + { + "input": { + "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "Tags": [ + { + "Key": "sampleKey", + "Value": "SampleValue" + } + ] + }, + "id": "example-1", + "title": "Sample TagResource call" + } + ], + "TestMapping": [ + { + "input": { + "fileFormat": "JSON", + "inputFileContent": "Sample file content", + "mappingTemplate": "$" + }, + "output": { + "mappedFileContent": "Sample file content" + }, + "id": "example-1", + "title": "Sample TestMapping call" + } + ], + "TestParsing": [ + { + "input": { + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "inputFile": { + "key": "sampleFile.txt", + "bucketName": "test-bucket" + } + }, + "output": { + "parsedFileContent": "Sample parsed file content" + }, + "id": "example-1", + "title": "Sample TestParsing call" + } + ], + "UntagResource": [ + { + "input": { + "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "TagKeys": [ + "sampleKey" + ] + }, + "id": "example-1", + "title": "Sample UntagResource call" + } + ], + "UpdateCapability": [ + { + "input": { + "name": "b2biexample", + "capabilityId": "ca-963a8121e4fc4e348", + "configuration": { + "edi": { + "type": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "inputLocation": { + "key": "input/", + "bucketName": "test-bucket" + }, + "outputLocation": { + "key": "output/", + "bucketName": "test-bucket" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "instructionsDocuments": [ + { + "key": "instructiondoc.txt", + "bucketName": "test-bucket" + } + ] + }, + "output": { + "name": "b2biexample", + "type": "edi", + "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + "capabilityId": "ca-963a8121e4fc4e348", + "configuration": { + "edi": { + "type": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "inputLocation": { + "key": "input/", + "bucketName": "test-bucket" + }, + "outputLocation": { + "key": "output/", + "bucketName": "test-bucket" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "createdAt": "2023-11-01T21:51:05.504Z", + "instructionsDocuments": [ + { + "key": "instructiondoc.txt", + "bucketName": "test-bucket" + } + ], + "modifiedAt": "2023-11-01T21:51:05.504Z" + }, + "id": "example-1", + "title": "Sample UpdateCapability call" + } + ], + "UpdatePartnership": [ + { + "input": { + "name": "b2bipartner", + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "partnershipId": "ps-219fa02f5b4242af8" + }, + "output": { + "name": "b2bipartner", + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", + "partnershipId": "ps-219fa02f5b4242af8", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + }, + "id": "example-1", + "title": "Sample UpdatePartnership call" + } + ], + "UpdateProfile": [ + { + "input": { + "name": "Shipping Profile", + "businessName": "John's Shipping", + "email": "john@example.com", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9" + }, + "output": { + "name": "Shipping Profile", + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "logging": "ENABLED", + "modifiedAt": "2023-11-02T21:51:05.504Z", + "phone": "5555555555", + "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "profileId": "p-60fbc37c87f04fce9" + }, + "id": "example-1", + "title": "Sample UpdateProfile call" + } + ], + "UpdateTransformer": [ + { + "input": { + "name": "transformJSON", + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "{}", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerId": "tr-974c129999f84d8c9" + }, + "output": { + "name": "transformJSON", + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "version": "VERSION_4010", + "transactionSet": "X12_110" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", + "transformerId": "tr-974c129999f84d8c9" + }, + "id": "example-1", + "title": "Sample UpdateTransformer call" + } + ] } } diff --git a/apis/cloudtrail/2013-11-01/api-2.json b/apis/cloudtrail/2013-11-01/api-2.json index d1865c09cbe..447ad8fbd2e 100644 --- a/apis/cloudtrail/2013-11-01/api-2.json +++ b/apis/cloudtrail/2013-11-01/api-2.json @@ -577,6 +577,21 @@ ], "idempotent":true }, + "ListInsightsMetricData":{ + "name":"ListInsightsMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInsightsMetricDataRequest"}, + "output":{"shape":"ListInsightsMetricDataResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"UnsupportedOperationException"} + ], + "idempotent":true + }, "ListPublicKeys":{ "name":"ListPublicKeys", "http":{ @@ -1558,6 +1573,7 @@ "FederationStatus":{"shape":"FederationStatus"} } }, + "Double":{"type":"double"}, "EnableFederationRequest":{ "type":"structure", "required":[ @@ -1577,6 +1593,11 @@ "FederationRoleArn":{"shape":"FederationRoleArn"} } }, + "ErrorCode":{ + "type":"string", + "max":128, + "pattern":"^[\\w\\d\\s_.,\\-:\\[\\]]+$" + }, "ErrorMessage":{ "type":"string", "max":1000, @@ -1723,6 +1744,11 @@ "type":"list", "member":{"shape":"EventDataStore"} }, + "EventName":{ + "type":"string", + "max":128, + "pattern":"^[A-Za-z0-9_]+$" + }, "EventSelector":{ "type":"structure", "members":{ @@ -1736,6 +1762,11 @@ "type":"list", "member":{"shape":"EventSelector"} }, + "EventSource":{ + "type":"string", + "max":256, + "pattern":"^[a-z0-9_-]+\\.amazonaws\\.com$" + }, "EventsList":{ "type":"list", "member":{"shape":"Event"} @@ -2055,6 +2086,32 @@ "ApiErrorRateInsight" ] }, + "InsightsMetricDataType":{ + "type":"string", + "enum":[ + "FillWithZeros", + "NonZeroData" + ] + }, + "InsightsMetricMaxResults":{ + "type":"integer", + "max":21600, + "min":1 + }, + "InsightsMetricNextToken":{ + "type":"string", + "max":5000, + "min":1 + }, + "InsightsMetricPeriod":{ + "type":"integer", + "max":3600, + "min":60 + }, + "InsightsMetricValues":{ + "type":"list", + "member":{"shape":"Double"} + }, "InsufficientDependencyServiceAccessPermissionException":{ "type":"structure", "members":{ @@ -2335,6 +2392,38 @@ "NextToken":{"shape":"PaginationToken"} } }, + "ListInsightsMetricDataRequest":{ + "type":"structure", + "required":[ + "EventSource", + "EventName", + "InsightType" + ], + "members":{ + "EventSource":{"shape":"EventSource"}, + "EventName":{"shape":"EventName"}, + "InsightType":{"shape":"InsightType"}, + "ErrorCode":{"shape":"ErrorCode"}, + "StartTime":{"shape":"Date"}, + "EndTime":{"shape":"Date"}, + "Period":{"shape":"InsightsMetricPeriod"}, + "DataType":{"shape":"InsightsMetricDataType"}, + "MaxResults":{"shape":"InsightsMetricMaxResults"}, + "NextToken":{"shape":"InsightsMetricNextToken"} + } + }, + "ListInsightsMetricDataResponse":{ + "type":"structure", + "members":{ + "EventSource":{"shape":"EventSource"}, + "EventName":{"shape":"EventName"}, + "InsightType":{"shape":"InsightType"}, + "ErrorCode":{"shape":"ErrorCode"}, + "Timestamps":{"shape":"Timestamps"}, + "Values":{"shape":"InsightsMetricValues"}, + "NextToken":{"shape":"InsightsMetricNextToken"} + } + }, "ListPublicKeysRequest":{ "type":"structure", "members":{ @@ -3009,6 +3098,10 @@ }, "exception":true }, + "Timestamps":{ + "type":"list", + "member":{"shape":"Date"} + }, "Trail":{ "type":"structure", "members":{ diff --git a/apis/cloudtrail/2013-11-01/docs-2.json b/apis/cloudtrail/2013-11-01/docs-2.json index 270e85c4364..f5bcd90fa0a 100644 --- a/apis/cloudtrail/2013-11-01/docs-2.json +++ b/apis/cloudtrail/2013-11-01/docs-2.json @@ -14,8 +14,8 @@ "DeregisterOrganizationDelegatedAdmin": "

Removes CloudTrail delegated administrator permissions from a member account in an organization.

", "DescribeQuery": "

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.

", "DescribeTrails": "

Retrieves settings for one or more trails associated with the current Region for your account.

", - "DisableFederation": "

Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail removes the metadata associated with the federated event data store in the Glue Data Catalog and removes registration for the federation role ARN and event data store in Lake Formation. No CloudTrail Lake data is deleted when you disable federation.

", - "EnableFederation": "

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 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 federated database named aws:cloudtrail (if the database doesn't already exist) and a 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 revoking or granting permissions to the federated resources in the Glue Data Catalog.

For more information about Lake query federation, see Federate an event data store.

", + "DisableFederation": "

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.

", + "EnableFederation": "

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 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.

", "GetChannel": "

Returns information about a specific channel.

", "GetEventDataStore": "

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

", "GetEventSelectors": "

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

For more information about logging management and data events, see the following topics in the CloudTrail User Guide:

", @@ -29,6 +29,7 @@ "ListEventDataStores": "

Returns information about all event data stores in the account, in the current Region.

", "ListImportFailures": "

Returns a list of failures for the specified import.

", "ListImports": "

Returns information on all imports, or a select set of imports by ImportStatus or Destination.

", + "ListInsightsMetricData": "

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.

Access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the cloudtrail:LookupEvents action.

", "ListPublicKeys": "

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.

", "ListQueries": "

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

", "ListTags": "

Lists the tags for the specified trails, event data stores, or channels in the current Region.

", @@ -48,7 +49,7 @@ "StopImport": "

Stops a specified import.

", "StopLogging": "

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.

", "UpdateChannel": "

Updates a channel specified by a required channel ARN or UUID.

", - "UpdateEventDataStore": "

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is 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, data, or Insights events in your event data store. For more information about AdvancedEventSelectors, see AdvancedEventSelectors.

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event data store.

", + "UpdateEventDataStore": "

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is 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.

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.

", "UpdateTrail": "

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

" }, "shapes": { @@ -369,6 +370,8 @@ "ImportsListItem$UpdatedTimestamp": "

The timestamp of the import's last update.

", "IngestionStatus$LatestIngestionSuccessTime": "

The time stamp of the most recent successful ingestion of events for the channel.

", "IngestionStatus$LatestIngestionAttemptTime": "

The time stamp of the most recent attempt to ingest events on the channel.

", + "ListInsightsMetricDataRequest$StartTime": "

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.

", + "ListInsightsMetricDataRequest$EndTime": "

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.

", "ListPublicKeysRequest$StartTime": "

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

", "ListPublicKeysRequest$EndTime": "

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

", "ListQueriesRequest$StartTime": "

Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

", @@ -391,6 +394,7 @@ "StopImportResponse$UpdatedTimestamp": "

The timestamp of the import's last update.

", "StopImportResponse$StartEventTime": "

Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

", "StopImportResponse$EndEventTime": "

Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

", + "Timestamps$member": null, "UpdateEventDataStoreResponse$CreatedTimestamp": "

The timestamp that shows when an event data store was first created.

", "UpdateEventDataStoreResponse$UpdatedTimestamp": "

The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

" } @@ -492,7 +496,7 @@ "DestinationType": { "base": null, "refs": { - "Destination$Type": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EventDataStore. For service-linked channels, the value is AWS_SERVICE.

" + "Destination$Type": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, the value is AWS_SERVICE.

" } }, "Destinations": { @@ -515,6 +519,12 @@ "refs": { } }, + "Double": { + "base": null, + "refs": { + "InsightsMetricValues$member": null + } + }, "EnableFederationRequest": { "base": null, "refs": { @@ -525,6 +535,13 @@ "refs": { } }, + "ErrorCode": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$ErrorCode": "

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.

", + "ListInsightsMetricDataResponse$ErrorCode": "

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.

" + } + }, "ErrorMessage": { "base": null, "refs": { @@ -658,6 +675,13 @@ "ListEventDataStoresResponse$EventDataStores": "

Contains information about event data stores in the account, in the current Region.

" } }, + "EventName": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$EventName": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

", + "ListInsightsMetricDataResponse$EventName": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

" + } + }, "EventSelector": { "base": "

Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. 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.

", "refs": { @@ -672,6 +696,13 @@ "PutEventSelectorsResponse$EventSelectors": "

Specifies the event selectors configured for your trail.

" } }, + "EventSource": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$EventSource": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

", + "ListInsightsMetricDataResponse$EventSource": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

" + } + }, "EventsList": { "base": null, "refs": { @@ -901,7 +932,40 @@ "InsightType": { "base": null, "refs": { - "InsightSelector$InsightType": "

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.

" + "InsightSelector$InsightType": "

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.

", + "ListInsightsMetricDataRequest$InsightType": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. 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.

", + "ListInsightsMetricDataResponse$InsightType": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. 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.

" + } + }, + "InsightsMetricDataType": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$DataType": "

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

" + } + }, + "InsightsMetricMaxResults": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$MaxResults": "

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

" + } + }, + "InsightsMetricNextToken": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$NextToken": "

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.

", + "ListInsightsMetricDataResponse$NextToken": "

Only returned if the full results could not be returned in a single query. You can set the NextToken parameter in the next request to this value to continue retrieval.

" + } + }, + "InsightsMetricPeriod": { + "base": null, + "refs": { + "ListInsightsMetricDataRequest$Period": "

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

" + } + }, + "InsightsMetricValues": { + "base": null, + "refs": { + "ListInsightsMetricDataResponse$Values": "

List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

" } }, "InsufficientDependencyServiceAccessPermissionException": { @@ -1141,6 +1205,16 @@ "refs": { } }, + "ListInsightsMetricDataRequest": { + "base": null, + "refs": { + } + }, + "ListInsightsMetricDataResponse": { + "base": null, + "refs": { + } + }, "ListPublicKeysRequest": { "base": "

Requests the public keys for a specified time range.

", "refs": { @@ -1606,7 +1680,7 @@ "SelectorField": { "base": null, "refs": { - "AdvancedFieldSelector$Field": "

A field in a CloudTrail event record on which to filter events to be logged. For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

For CloudTrail event records, supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is eventCategory.

" + "AdvancedFieldSelector$Field": "

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.

" } }, "SelectorName": { @@ -1708,7 +1782,7 @@ "CreateTrailRequest$S3BucketName": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

", "CreateTrailRequest$S3KeyPrefix": "

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. The maximum length is 200 characters.

", "CreateTrailRequest$SnsTopicName": "

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

", - "CreateTrailRequest$CloudWatchLogsLogGroupArn": "

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.

Only the management account can configure a CloudWatch Logs log group for an organization trail.

", + "CreateTrailRequest$CloudWatchLogsLogGroupArn": "

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.

", "CreateTrailRequest$CloudWatchLogsRoleArn": "

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.

", "CreateTrailRequest$KmsKeyId": "

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 in the Key Management Service Developer Guide.

Examples:

", "CreateTrailResponse$Name": "

Specifies the name of the trail.

", @@ -1720,7 +1794,7 @@ "CreateTrailResponse$CloudWatchLogsLogGroupArn": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

", "CreateTrailResponse$CloudWatchLogsRoleArn": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

", "CreateTrailResponse$KmsKeyId": "

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

", - "DataResource$Type": "

The resource type in which you want to log data events. You can specify the following basic event selector resource types:

The following resource types are also available through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector.

", + "DataResource$Type": "

The resource type in which you want to log data events. You can specify the following basic event selector resource types:

Additional resource types are available through advanced event selectors. For more information about these additional resource types, see AdvancedFieldSelector.

", "DataResourceValues$member": null, "DeleteTrailRequest$Name": "

Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

", "Event$EventId": "

The CloudTrail ID of the event returned.

", @@ -1789,7 +1863,7 @@ "UpdateTrailRequest$S3BucketName": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

", "UpdateTrailRequest$S3KeyPrefix": "

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. The maximum length is 200 characters.

", "UpdateTrailRequest$SnsTopicName": "

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

", - "UpdateTrailRequest$CloudWatchLogsLogGroupArn": "

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.

Only the management account can configure a CloudWatch Logs log group for an organization trail.

", + "UpdateTrailRequest$CloudWatchLogsLogGroupArn": "

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.

", "UpdateTrailRequest$CloudWatchLogsRoleArn": "

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.

", "UpdateTrailRequest$KmsKeyId": "

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 in the Key Management Service Developer Guide.

Examples:

", "UpdateTrailResponse$Name": "

Specifies the name of the trail.

", @@ -1856,6 +1930,12 @@ "refs": { } }, + "Timestamps": { + "base": null, + "refs": { + "ListInsightsMetricDataResponse$Timestamps": "

List of timestamps at intervals corresponding to the specified time period.

" + } + }, "Trail": { "base": "

The settings for a trail.

", "refs": { diff --git a/apis/cloudtrail/2013-11-01/paginators-1.json b/apis/cloudtrail/2013-11-01/paginators-1.json index ffea9aec302..3aba1f437f2 100644 --- a/apis/cloudtrail/2013-11-01/paginators-1.json +++ b/apis/cloudtrail/2013-11-01/paginators-1.json @@ -29,6 +29,11 @@ "output_token": "NextToken", "result_key": "Imports" }, + "ListInsightsMetricData": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "ListPublicKeys": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/apis/connect/2017-08-08/api-2.json b/apis/connect/2017-08-08/api-2.json index beebc0e4a70..fcf379598ef 100644 --- a/apis/connect/2017-08-08/api-2.json +++ b/apis/connect/2017-08-08/api-2.json @@ -8555,7 +8555,7 @@ "GroupingsV2":{ "type":"list", "member":{"shape":"GroupingV2"}, - "max":2 + "max":3 }, "HierarchyGroup":{ "type":"structure", diff --git a/apis/connect/2017-08-08/docs-2.json b/apis/connect/2017-08-08/docs-2.json index 15ee8eee56a..b6250b71c2e 100644 --- a/apis/connect/2017-08-08/docs-2.json +++ b/apis/connect/2017-08-08/docs-2.json @@ -3033,14 +3033,14 @@ "Filters": { "base": "

Contains the filter to apply when retrieving metrics.

", "refs": { - "GetCurrentMetricDataRequest$Filters": "

The filters to apply to returned metrics. You can filter up to the following limits:

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 RoutingStepExpression, you need to pass exactly one QueueId.

Currently tagging is only supported on the resources that are passed in the filter.

", + "GetCurrentMetricDataRequest$Filters": "

The filters to apply to returned metrics. You can filter up to the following limits:

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.

", "GetMetricDataRequest$Filters": "

The queues, up to 100, or channels, to use to filter the metrics returned. 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.

" } }, "FiltersV2List": { "base": null, "refs": { - "GetMetricDataV2Request$Filters": "

The filters to apply to returned metrics. You can filter on the following resources:

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 in the Amazon Connect Administrator's Guide.

Note the following limits:

" + "GetMetricDataV2Request$Filters": "

The filters to apply to returned metrics. You can filter on the following resources:

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 in the Amazon Connect Administrator's Guide.

Note the following limits:

" } }, "FlowAssociationResourceType": { @@ -4760,7 +4760,7 @@ "MetricsV2": { "base": null, "refs": { - "GetMetricDataV2Request$Metrics": "

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 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

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

AGENT_ANSWER_RATE

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_ADHERENT_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_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.

AGENT_OCCUPANCY

Unit: Percentage

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULE_ADHERENCE

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULED_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_ABANDON_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

AVG_ACTIVE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

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

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

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

AVG_CONTACT_DURATION

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

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

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

AVG_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

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

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

AVG_HOLDS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

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

AVG_INTERACTION_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

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

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

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

AVG_QUEUE_ANSWER_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

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

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

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

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

CONTACTS_ABANDONED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

CONTACTS_CREATED

Unit: Count

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

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

Feature is a valid filter but not a valid grouping.
CONTACTS_HOLD_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_ON_HOLD_AGENT_DISCONNECT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_PUT_ON_HOLD

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_EXTERNAL

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_INTERNAL

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

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\").

CONTACTS_TRANSFERRED_OUT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

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

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

MAX_QUEUED_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

PERCENT_CONTACTS_STEP_EXPIRED

Unit: Percent

Valid groupings and filters: Queue, RoutingStepExpression

PERCENT_CONTACTS_STEP_JOINED

Unit: Percent

Valid groupings and filters: Queue, RoutingStepExpression

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

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

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

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

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\").

STEP_CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, RoutingStepExpression

SUM_AFTER_CONTACT_WORK_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

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

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

SUM_CONTACT_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

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\").

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\").

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

SUM_ERROR_STATUS_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_HOLD_TIME

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_IDLE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_INTERACTION_AND_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_INTERACTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_NON_PRODUCTIVE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_ONLINE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_RETRY_CALLBACK_ATTEMPTS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

" + "GetMetricDataV2Request$Metrics": "

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 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

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

AGENT_ANSWER_RATE

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_ADHERENT_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_NON_RESPONSE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_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.

AGENT_OCCUPANCY

Unit: Percentage

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULE_ADHERENCE

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AGENT_SCHEDULED_TIME

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

AVG_ABANDON_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

AVG_ACTIVE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

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

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

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

AVG_CONTACT_DURATION

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

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

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

AVG_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

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

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

AVG_HOLDS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

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

AVG_INTERACTION_TIME

Unit: Seconds

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

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

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

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

AVG_QUEUE_ANSWER_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

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

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

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

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

CONTACTS_ABANDONED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

CONTACTS_CREATED

Unit: Count

Valid metric filter key: INITIATION_METHOD

Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

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

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

CONTACTS_HOLD_ABANDONS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_ON_HOLD_AGENT_DISCONNECT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_PUT_ON_HOLD

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_EXTERNAL

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_TRANSFERRED_OUT_INTERNAL

Unit: Percent

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

CONTACTS_QUEUED_BY_ENQUEUE

Unit: Count

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

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\").

CONTACTS_TRANSFERRED_OUT

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

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

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

MAX_QUEUED_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

PERCENT_CONTACTS_STEP_EXPIRED

Unit: Percent

Valid groupings and filters: Queue, RoutingStepExpression

PERCENT_CONTACTS_STEP_JOINED

Unit: Percent

Valid groupings and filters: Queue, RoutingStepExpression

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

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

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

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

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\").

STEP_CONTACTS_QUEUED

Unit: Count

Valid groupings and filters: Queue, RoutingStepExpression

SUM_AFTER_CONTACT_WORK_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

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

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

SUM_CONTACT_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

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\").

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\").

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

SUM_ERROR_STATUS_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_HANDLE_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_HOLD_TIME

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_IDLE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_INTERACTION_AND_HOLD_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_INTERACTION_TIME

Unit: Seconds

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

SUM_NON_PRODUCTIVE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_ONLINE_TIME_AGENT

Unit: Seconds

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

SUM_RETRY_CALLBACK_ATTEMPTS

Unit: Count

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

" } }, "MinutesLimit60": { @@ -7682,9 +7682,9 @@ "DeleteTrafficDistributionGroupRequest$TrafficDistributionGroupId": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

", "DescribeTrafficDistributionGroupRequest$TrafficDistributionGroupId": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

", "DisassociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

", - "GetTrafficDistributionRequest$Id": "

The identifier of the traffic distribution group.

", + "GetTrafficDistributionRequest$Id": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

", "ListTrafficDistributionGroupUsersRequest$TrafficDistributionGroupId": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

", - "UpdateTrafficDistributionRequest$Id": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

" + "UpdateTrafficDistributionRequest$Id": "

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

" } }, "TrafficDistributionGroupStatus": { diff --git a/apis/drs/2020-02-26/api-2.json b/apis/drs/2020-02-26/api-2.json index a18712a7c96..f82267b2347 100644 --- a/apis/drs/2020-02-26/api-2.json +++ b/apis/drs/2020-02-26/api-2.json @@ -1891,6 +1891,7 @@ }, "LaunchActionOrder":{ "type":"integer", + "box":true, "max":10000, "min":2 }, @@ -2173,11 +2174,13 @@ }, "MaxResultsReplicatingSourceServers":{ "type":"integer", + "box":true, "max":300, "min":1 }, "MaxResultsType":{ "type":"integer", + "box":true, "max":1000, "min":1 }, @@ -3023,6 +3026,7 @@ }, "StrictlyPositiveInteger":{ "type":"integer", + "box":true, "min":1 }, "SubnetID":{ diff --git a/apis/firehose/2015-08-04/api-2.json b/apis/firehose/2015-08-04/api-2.json index 2c1375baae3..b85b1f1c280 100644 --- a/apis/firehose/2015-08-04/api-2.json +++ b/apis/firehose/2015-08-04/api-2.json @@ -530,7 +530,8 @@ "HttpEndpointDestinationConfiguration":{"shape":"HttpEndpointDestinationConfiguration"}, "Tags":{"shape":"TagDeliveryStreamInputTagList"}, "AmazonOpenSearchServerlessDestinationConfiguration":{"shape":"AmazonOpenSearchServerlessDestinationConfiguration"}, - "MSKSourceConfiguration":{"shape":"MSKSourceConfiguration"} + "MSKSourceConfiguration":{"shape":"MSKSourceConfiguration"}, + "SnowflakeDestinationConfiguration":{"shape":"SnowflakeDestinationConfiguration"} } }, "CreateDeliveryStreamOutput":{ @@ -740,6 +741,7 @@ "AmazonopensearchserviceDestinationDescription":{"shape":"AmazonopensearchserviceDestinationDescription"}, "SplunkDestinationDescription":{"shape":"SplunkDestinationDescription"}, "HttpEndpointDestinationDescription":{"shape":"HttpEndpointDestinationDescription"}, + "SnowflakeDestinationDescription":{"shape":"SnowflakeDestinationDescription"}, "AmazonOpenSearchServerlessDestinationDescription":{"shape":"AmazonOpenSearchServerlessDestinationDescription"} } }, @@ -1818,6 +1820,191 @@ "max":128, "min":1 }, + "SnowflakeAccountUrl":{ + "type":"string", + "max":2048, + "min":24, + "pattern":".+?\\.snowflakecomputing\\.com", + "sensitive":true + }, + "SnowflakeContentColumnName":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakeDataLoadingOption":{ + "type":"string", + "enum":[ + "JSON_MAPPING", + "VARIANT_CONTENT_MAPPING", + "VARIANT_CONTENT_AND_METADATA_MAPPING" + ] + }, + "SnowflakeDatabase":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakeDestinationConfiguration":{ + "type":"structure", + "required":[ + "AccountUrl", + "PrivateKey", + "User", + "Database", + "Schema", + "Table", + "RoleARN", + "S3Configuration" + ], + "members":{ + "AccountUrl":{"shape":"SnowflakeAccountUrl"}, + "PrivateKey":{"shape":"SnowflakePrivateKey"}, + "KeyPassphrase":{"shape":"SnowflakeKeyPassphrase"}, + "User":{"shape":"SnowflakeUser"}, + "Database":{"shape":"SnowflakeDatabase"}, + "Schema":{"shape":"SnowflakeSchema"}, + "Table":{"shape":"SnowflakeTable"}, + "SnowflakeRoleConfiguration":{"shape":"SnowflakeRoleConfiguration"}, + "DataLoadingOption":{"shape":"SnowflakeDataLoadingOption"}, + "MetaDataColumnName":{"shape":"SnowflakeMetaDataColumnName"}, + "ContentColumnName":{"shape":"SnowflakeContentColumnName"}, + "SnowflakeVpcConfiguration":{"shape":"SnowflakeVpcConfiguration"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "RoleARN":{"shape":"RoleARN"}, + "RetryOptions":{"shape":"SnowflakeRetryOptions"}, + "S3BackupMode":{"shape":"SnowflakeS3BackupMode"}, + "S3Configuration":{"shape":"S3DestinationConfiguration"} + } + }, + "SnowflakeDestinationDescription":{ + "type":"structure", + "members":{ + "AccountUrl":{"shape":"SnowflakeAccountUrl"}, + "User":{"shape":"SnowflakeUser"}, + "Database":{"shape":"SnowflakeDatabase"}, + "Schema":{"shape":"SnowflakeSchema"}, + "Table":{"shape":"SnowflakeTable"}, + "SnowflakeRoleConfiguration":{"shape":"SnowflakeRoleConfiguration"}, + "DataLoadingOption":{"shape":"SnowflakeDataLoadingOption"}, + "MetaDataColumnName":{"shape":"SnowflakeMetaDataColumnName"}, + "ContentColumnName":{"shape":"SnowflakeContentColumnName"}, + "SnowflakeVpcConfiguration":{"shape":"SnowflakeVpcConfiguration"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "RoleARN":{"shape":"RoleARN"}, + "RetryOptions":{"shape":"SnowflakeRetryOptions"}, + "S3BackupMode":{"shape":"SnowflakeS3BackupMode"}, + "S3DestinationDescription":{"shape":"S3DestinationDescription"} + } + }, + "SnowflakeDestinationUpdate":{ + "type":"structure", + "members":{ + "AccountUrl":{"shape":"SnowflakeAccountUrl"}, + "PrivateKey":{"shape":"SnowflakePrivateKey"}, + "KeyPassphrase":{"shape":"SnowflakeKeyPassphrase"}, + "User":{"shape":"SnowflakeUser"}, + "Database":{"shape":"SnowflakeDatabase"}, + "Schema":{"shape":"SnowflakeSchema"}, + "Table":{"shape":"SnowflakeTable"}, + "SnowflakeRoleConfiguration":{"shape":"SnowflakeRoleConfiguration"}, + "DataLoadingOption":{"shape":"SnowflakeDataLoadingOption"}, + "MetaDataColumnName":{"shape":"SnowflakeMetaDataColumnName"}, + "ContentColumnName":{"shape":"SnowflakeContentColumnName"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "RoleARN":{"shape":"RoleARN"}, + "RetryOptions":{"shape":"SnowflakeRetryOptions"}, + "S3BackupMode":{"shape":"SnowflakeS3BackupMode"}, + "S3Update":{"shape":"S3DestinationUpdate"} + } + }, + "SnowflakeKeyPassphrase":{ + "type":"string", + "max":255, + "min":7, + "sensitive":true + }, + "SnowflakeMetaDataColumnName":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakePrivateKey":{ + "type":"string", + "max":4096, + "min":256, + "pattern":"^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$", + "sensitive":true + }, + "SnowflakePrivateLinkVpceId":{ + "type":"string", + "max":255, + "min":47, + "pattern":"([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$", + "sensitive":true + }, + "SnowflakeRetryDurationInSeconds":{ + "type":"integer", + "max":7200, + "min":0 + }, + "SnowflakeRetryOptions":{ + "type":"structure", + "members":{ + "DurationInSeconds":{"shape":"SnowflakeRetryDurationInSeconds"} + } + }, + "SnowflakeRole":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakeRoleConfiguration":{ + "type":"structure", + "members":{ + "Enabled":{"shape":"BooleanObject"}, + "SnowflakeRole":{"shape":"SnowflakeRole"} + } + }, + "SnowflakeS3BackupMode":{ + "type":"string", + "enum":[ + "FailedDataOnly", + "AllData" + ] + }, + "SnowflakeSchema":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakeTable":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakeUser":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "SnowflakeVpcConfiguration":{ + "type":"structure", + "required":["PrivateLinkVpceId"], + "members":{ + "PrivateLinkVpceId":{"shape":"SnowflakePrivateLinkVpceId"} + } + }, "SourceDescription":{ "type":"structure", "members":{ @@ -2034,7 +2221,8 @@ "AmazonopensearchserviceDestinationUpdate":{"shape":"AmazonopensearchserviceDestinationUpdate"}, "SplunkDestinationUpdate":{"shape":"SplunkDestinationUpdate"}, "HttpEndpointDestinationUpdate":{"shape":"HttpEndpointDestinationUpdate"}, - "AmazonOpenSearchServerlessDestinationUpdate":{"shape":"AmazonOpenSearchServerlessDestinationUpdate"} + "AmazonOpenSearchServerlessDestinationUpdate":{"shape":"AmazonOpenSearchServerlessDestinationUpdate"}, + "SnowflakeDestinationUpdate":{"shape":"SnowflakeDestinationUpdate"} } }, "UpdateDestinationOutput":{ diff --git a/apis/firehose/2015-08-04/docs-2.json b/apis/firehose/2015-08-04/docs-2.json index a2f02b67a6b..7dba048cd44 100644 --- a/apis/firehose/2015-08-04/docs-2.json +++ b/apis/firehose/2015-08-04/docs-2.json @@ -228,7 +228,8 @@ "ParquetSerDe$EnableDictionaryCompression": "

Indicates whether to enable dictionary compression.

", "ProcessingConfiguration$Enabled": "

Enables or disables data processing.

", "PutRecordBatchOutput$Encrypted": "

Indicates whether server-side encryption (SSE) was enabled during this operation.

", - "PutRecordOutput$Encrypted": "

Indicates whether server-side encryption (SSE) was enabled during this operation.

" + "PutRecordOutput$Encrypted": "

Indicates whether server-side encryption (SSE) was enabled during this operation.

", + "SnowflakeRoleConfiguration$Enabled": "

Enable Snowflake role

" } }, "BucketARN": { @@ -277,6 +278,9 @@ "S3DestinationConfiguration$CloudWatchLoggingOptions": "

The CloudWatch logging options for your delivery stream.

", "S3DestinationDescription$CloudWatchLoggingOptions": "

The Amazon CloudWatch logging options for your delivery stream.

", "S3DestinationUpdate$CloudWatchLoggingOptions": "

The CloudWatch logging options for your delivery stream.

", + "SnowflakeDestinationConfiguration$CloudWatchLoggingOptions": null, + "SnowflakeDestinationDescription$CloudWatchLoggingOptions": null, + "SnowflakeDestinationUpdate$CloudWatchLoggingOptions": null, "SplunkDestinationConfiguration$CloudWatchLoggingOptions": "

The Amazon CloudWatch logging options for your delivery stream.

", "SplunkDestinationDescription$CloudWatchLoggingOptions": "

The Amazon CloudWatch logging options for your delivery stream.

", "SplunkDestinationUpdate$CloudWatchLoggingOptions": "

The Amazon CloudWatch logging options for your delivery stream.

" @@ -1160,6 +1164,9 @@ "RedshiftDestinationConfiguration$ProcessingConfiguration": "

The data processing configuration.

", "RedshiftDestinationDescription$ProcessingConfiguration": "

The data processing configuration.

", "RedshiftDestinationUpdate$ProcessingConfiguration": "

The data processing configuration.

", + "SnowflakeDestinationConfiguration$ProcessingConfiguration": null, + "SnowflakeDestinationDescription$ProcessingConfiguration": null, + "SnowflakeDestinationUpdate$ProcessingConfiguration": null, "SplunkDestinationConfiguration$ProcessingConfiguration": "

The data processing configuration.

", "SplunkDestinationDescription$ProcessingConfiguration": "

The data processing configuration.

", "SplunkDestinationUpdate$ProcessingConfiguration": "

The data processing configuration.

" @@ -1356,6 +1363,9 @@ "S3DestinationConfiguration$RoleARN": "

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.

", "S3DestinationDescription$RoleARN": "

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.

", "S3DestinationUpdate$RoleARN": "

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.

", + "SnowflakeDestinationConfiguration$RoleARN": "

The Amazon Resource Name (ARN) of the Snowflake role

", + "SnowflakeDestinationDescription$RoleARN": "

The Amazon Resource Name (ARN) of the Snowflake role

", + "SnowflakeDestinationUpdate$RoleARN": "

The Amazon Resource Name (ARN) of the Snowflake role

", "VpcConfiguration$RoleARN": "

The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

", "VpcConfigurationDescription$RoleARN": "

The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

" } @@ -1379,6 +1389,7 @@ "HttpEndpointDestinationConfiguration$S3Configuration": null, "RedshiftDestinationConfiguration$S3Configuration": "

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.

", "RedshiftDestinationConfiguration$S3BackupConfiguration": "

The configuration for backup in Amazon S3.

", + "SnowflakeDestinationConfiguration$S3Configuration": null, "SplunkDestinationConfiguration$S3Configuration": "

The configuration for the backup Amazon S3 location.

" } }, @@ -1393,6 +1404,7 @@ "HttpEndpointDestinationDescription$S3DestinationDescription": null, "RedshiftDestinationDescription$S3DestinationDescription": "

The Amazon S3 destination.

", "RedshiftDestinationDescription$S3BackupDescription": "

The configuration for backup in Amazon S3.

", + "SnowflakeDestinationDescription$S3DestinationDescription": null, "SplunkDestinationDescription$S3DestinationDescription": "

The Amazon S3 destination.>

" } }, @@ -1406,6 +1418,7 @@ "HttpEndpointDestinationUpdate$S3Update": null, "RedshiftDestinationUpdate$S3Update": "

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.

", "RedshiftDestinationUpdate$S3BackupUpdate": "

The Amazon S3 destination for backup.

", + "SnowflakeDestinationUpdate$S3Update": null, "SplunkDestinationUpdate$S3Update": "

Your update to the configuration of the backup Amazon S3 location.

", "UpdateDestinationInput$S3DestinationUpdate": "

[Deprecated] Describes an update for a destination in Amazon S3.

" } @@ -1440,6 +1453,151 @@ "BufferingHints$SizeInMBs": "

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.

" } }, + "SnowflakeAccountUrl": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$AccountUrl": "

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

", + "SnowflakeDestinationDescription$AccountUrl": "

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

", + "SnowflakeDestinationUpdate$AccountUrl": "

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

" + } + }, + "SnowflakeContentColumnName": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$ContentColumnName": "

The name of the record content column

", + "SnowflakeDestinationDescription$ContentColumnName": "

The name of the record content column

", + "SnowflakeDestinationUpdate$ContentColumnName": "

The name of the content metadata column

" + } + }, + "SnowflakeDataLoadingOption": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$DataLoadingOption": "

Choose to load 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.

", + "SnowflakeDestinationDescription$DataLoadingOption": "

Choose to load 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.

", + "SnowflakeDestinationUpdate$DataLoadingOption": "

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.

" + } + }, + "SnowflakeDatabase": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$Database": "

All data in Snowflake is maintained in databases.

", + "SnowflakeDestinationDescription$Database": "

All data in Snowflake is maintained in databases.

", + "SnowflakeDestinationUpdate$Database": "

All data in Snowflake is maintained in databases.

" + } + }, + "SnowflakeDestinationConfiguration": { + "base": "

Configure Snowflake destination

", + "refs": { + "CreateDeliveryStreamInput$SnowflakeDestinationConfiguration": "

Configure Snowflake destination

" + } + }, + "SnowflakeDestinationDescription": { + "base": "

Optional Snowflake destination description

", + "refs": { + "DestinationDescription$SnowflakeDestinationDescription": "

Optional description for the destination

" + } + }, + "SnowflakeDestinationUpdate": { + "base": "

Update to configuration settings

", + "refs": { + "UpdateDestinationInput$SnowflakeDestinationUpdate": "

Update to the Snowflake destination condiguration settings

" + } + }, + "SnowflakeKeyPassphrase": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$KeyPassphrase": "

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

", + "SnowflakeDestinationUpdate$KeyPassphrase": "

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

" + } + }, + "SnowflakeMetaDataColumnName": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$MetaDataColumnName": "

The name of the record metadata column

", + "SnowflakeDestinationDescription$MetaDataColumnName": "

The name of the record metadata column

", + "SnowflakeDestinationUpdate$MetaDataColumnName": "

The name of the record metadata column

" + } + }, + "SnowflakePrivateKey": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$PrivateKey": "

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

", + "SnowflakeDestinationUpdate$PrivateKey": "

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

" + } + }, + "SnowflakePrivateLinkVpceId": { + "base": null, + "refs": { + "SnowflakeVpcConfiguration$PrivateLinkVpceId": "

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

" + } + }, + "SnowflakeRetryDurationInSeconds": { + "base": null, + "refs": { + "SnowflakeRetryOptions$DurationInSeconds": "

the time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.

" + } + }, + "SnowflakeRetryOptions": { + "base": "

Specify how long Kinesis Data Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Kinesis 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, Kinesis Data Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Kinesis Data Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Kinesis Data 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, Kinesis Data Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Kinesis Data 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 Kinesis Data Firehose to retry sending data, set this value to 0.

", + "refs": { + "SnowflakeDestinationConfiguration$RetryOptions": "

The time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.

", + "SnowflakeDestinationDescription$RetryOptions": "

The time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.

", + "SnowflakeDestinationUpdate$RetryOptions": "

Specify how long Kinesis Data Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Kinesis 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, Kinesis Data Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Kinesis Data Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Kinesis Data 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, Kinesis Data Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Kinesis Data 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 Kinesis Data Firehose to retry sending data, set this value to 0.

" + } + }, + "SnowflakeRole": { + "base": null, + "refs": { + "SnowflakeRoleConfiguration$SnowflakeRole": "

The Snowflake role you wish to configure

" + } + }, + "SnowflakeRoleConfiguration": { + "base": "

Optionally configure a Snowflake role. Otherwise the default user role will be used.

", + "refs": { + "SnowflakeDestinationConfiguration$SnowflakeRoleConfiguration": "

Optionally configure a Snowflake role. Otherwise the default user role will be used.

", + "SnowflakeDestinationDescription$SnowflakeRoleConfiguration": "

Optionally configure a Snowflake role. Otherwise the default user role will be used.

", + "SnowflakeDestinationUpdate$SnowflakeRoleConfiguration": "

Optionally configure a Snowflake role. Otherwise the default user role will be used.

" + } + }, + "SnowflakeS3BackupMode": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$S3BackupMode": "

Choose an S3 backup mode

", + "SnowflakeDestinationDescription$S3BackupMode": "

Choose an S3 backup mode

", + "SnowflakeDestinationUpdate$S3BackupMode": "

Choose an S3 backup mode

" + } + }, + "SnowflakeSchema": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$Schema": "

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

", + "SnowflakeDestinationDescription$Schema": "

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

", + "SnowflakeDestinationUpdate$Schema": "

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

" + } + }, + "SnowflakeTable": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$Table": "

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

", + "SnowflakeDestinationDescription$Table": "

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

", + "SnowflakeDestinationUpdate$Table": "

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

" + } + }, + "SnowflakeUser": { + "base": null, + "refs": { + "SnowflakeDestinationConfiguration$User": "

User login name for the Snowflake account.

", + "SnowflakeDestinationDescription$User": "

User login name for the Snowflake account.

", + "SnowflakeDestinationUpdate$User": "

User login name for the Snowflake account.

" + } + }, + "SnowflakeVpcConfiguration": { + "base": "

Configure a Snowflake VPC

", + "refs": { + "SnowflakeDestinationConfiguration$SnowflakeVpcConfiguration": "

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

", + "SnowflakeDestinationDescription$SnowflakeVpcConfiguration": "

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

" + } + }, "SourceDescription": { "base": "

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

", "refs": { diff --git a/apis/sagemaker-featurestore-runtime/2020-07-01/api-2.json b/apis/sagemaker-featurestore-runtime/2020-07-01/api-2.json index aa826dc2ad4..6d4ff9f9b9a 100644 --- a/apis/sagemaker-featurestore-runtime/2020-07-01/api-2.json +++ b/apis/sagemaker-featurestore-runtime/2020-07-01/api-2.json @@ -117,7 +117,7 @@ "BatchGetRecordIdentifiers":{ "type":"list", "member":{"shape":"BatchGetRecordIdentifier"}, - "max":10, + "max":100, "min":1 }, "BatchGetRecordRequest":{ diff --git a/apis/sagemaker-featurestore-runtime/2020-07-01/docs-2.json b/apis/sagemaker-featurestore-runtime/2020-07-01/docs-2.json index 674a16c9e1f..5b48ab2c549 100644 --- a/apis/sagemaker-featurestore-runtime/2020-07-01/docs-2.json +++ b/apis/sagemaker-featurestore-runtime/2020-07-01/docs-2.json @@ -3,7 +3,7 @@ "service": "

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:

", "operations": { "BatchGetRecord": "

Retrieves a batch of Records from a FeatureGroup.

", - "DeleteRecord": "

Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both SoftDelete and HardDelete. For SoftDelete (default), feature columns are set to null and the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to the OfflineStore with feature values set to null, is_deleted value set to True, and EventTime set to the delete input EventTime.

Note that the EventTime specified in DeleteRecord should be set later than the EventTime of the existing record in the OnlineStore for that RecordIdentifer. If it is not, the deletion does not occur:

", + "DeleteRecord": "

Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both SoftDelete and HardDelete. For SoftDelete (default), feature columns are set to null and the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to 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:

When a record is deleted from the OnlineStore, the deleted record marker is 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.

", "GetRecord": "

Use for OnlineStore serving from a FeatureStore. Only the latest records stored in the OnlineStore can be retrieved. If no Record with RecordIdentifierValue is found, then an empty result is returned.

", "PutRecord": "

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.

" }, diff --git a/apis/sagemaker-featurestore-runtime/2020-07-01/endpoint-rule-set-1.json b/apis/sagemaker-featurestore-runtime/2020-07-01/endpoint-rule-set-1.json index 82741fc74cc..f00d2c2e257 100644 --- a/apis/sagemaker-featurestore-runtime/2020-07-01/endpoint-rule-set-1.json +++ b/apis/sagemaker-featurestore-runtime/2020-07-01/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/gems/aws-partitions/CHANGELOG.md b/gems/aws-partitions/CHANGELOG.md index 908d5aa65d2..0a9cbd9827e 100644 --- a/gems/aws-partitions/CHANGELOG.md +++ b/gems/aws-partitions/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.882.0 (2024-01-18) +------------------ + +* Feature - Updated the partitions source data the determines the AWS service regions and endpoints. + 1.881.0 (2024-01-16) ------------------ diff --git a/gems/aws-partitions/VERSION b/gems/aws-partitions/VERSION index 391bf5f9261..cb9f1787c8f 100644 --- a/gems/aws-partitions/VERSION +++ b/gems/aws-partitions/VERSION @@ -1 +1 @@ -1.881.0 +1.882.0 diff --git a/gems/aws-partitions/partitions.json b/gems/aws-partitions/partitions.json index 1d0ff98ced9..c1ed6d00f02 100644 --- a/gems/aws-partitions/partitions.json +++ b/gems/aws-partitions/partitions.json @@ -13240,6 +13240,12 @@ }, "hostname" : "portal.sso.il-central-1.amazonaws.com" }, + "me-central-1" : { + "credentialScope" : { + "region" : "me-central-1" + }, + "hostname" : "portal.sso.me-central-1.amazonaws.com" + }, "me-south-1" : { "credentialScope" : { "region" : "me-south-1" diff --git a/gems/aws-sdk-b2bi/CHANGELOG.md b/gems/aws-sdk-b2bi/CHANGELOG.md index 72c1d5fb899..b69162898e4 100644 --- a/gems/aws-sdk-b2bi/CHANGELOG.md +++ b/gems/aws-sdk-b2bi/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.3.0 (2024-01-18) +------------------ + +* Feature - Increasing TestMapping inputFileContent file size limit to 5MB and adding file size limit 250KB for TestParsing input file. This release also includes exposing InternalServerException for Tag APIs. + 1.2.0 (2023-12-14) ------------------ diff --git a/gems/aws-sdk-b2bi/VERSION b/gems/aws-sdk-b2bi/VERSION index 26aaba0e866..f0bb29e7638 100644 --- a/gems/aws-sdk-b2bi/VERSION +++ b/gems/aws-sdk-b2bi/VERSION @@ -1 +1 @@ -1.2.0 +1.3.0 diff --git a/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi.rb b/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi.rb index 1159fbc73bb..abc3c1f9e83 100644 --- a/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi.rb +++ b/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi.rb @@ -52,6 +52,6 @@ # @!group service module Aws::B2bi - GEM_VERSION = '1.2.0' + GEM_VERSION = '1.3.0' end diff --git a/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb b/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb index 779f6e033b2..3a4edabc5a5 100644 --- a/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb +++ b/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb @@ -438,6 +438,80 @@ def initialize(*args) # * {Types::CreateCapabilityResponse#instructions_documents #instructions_documents} => Array<Types::S3Location> # * {Types::CreateCapabilityResponse#created_at #created_at} => Time # + # + # @example Example: Sample CreateCapability call + # + # resp = client.create_capability({ + # name: "b2biexample", + # type: "edi", + # client_token: "foo", + # configuration: { + # edi: { + # type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # input_location: { + # key: "input/", + # bucket_name: "test-bucket", + # }, + # output_location: { + # key: "output/", + # bucket_name: "test-bucket", + # }, + # transformer_id: "tr-9a893cf536df4658b", + # }, + # }, + # instructions_documents: [ + # { + # key: "instructiondoc.txt", + # bucket_name: "test-bucket", + # }, + # ], + # tags: [ + # { + # key: "capabilityKey1", + # value: "capabilityValue1", + # }, + # ], + # }) + # + # resp.to_h outputs the following: + # { + # name: "b2biexample", + # type: "edi", + # capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + # capability_id: "ca-963a8121e4fc4e348", + # configuration: { + # edi: { + # type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # input_location: { + # key: "input/", + # bucket_name: "test-bucket", + # }, + # output_location: { + # key: "output/", + # bucket_name: "test-bucket", + # }, + # transformer_id: "tr-9a893cf536df4658b", + # }, + # }, + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # instructions_documents: [ + # { + # key: "instructiondoc.txt", + # bucket_name: "test-bucket", + # }, + # ], + # } + # # @example Request syntax with placeholder values # # resp = client.create_capability({ @@ -548,6 +622,41 @@ def create_capability(params = {}, options = {}) # * {Types::CreatePartnershipResponse#trading_partner_id #trading_partner_id} => String # * {Types::CreatePartnershipResponse#created_at #created_at} => Time # + # + # @example Example: Sample CreatePartnership call + # + # resp = client.create_partnership({ + # name: "b2bipartner", + # capabilities: [ + # "ca-963a8121e4fc4e348", + # ], + # client_token: "foo", + # email: "john@example.com", + # phone: "5555555555", + # profile_id: "p-60fbc37c87f04fce9", + # tags: [ + # { + # key: "sampleKey1", + # value: "sampleValue1", + # }, + # ], + # }) + # + # resp.to_h outputs the following: + # { + # name: "b2bipartner", + # capabilities: [ + # "ca-963a8121e4fc4e348", + # ], + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # email: "john@example.com", + # partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", + # partnership_id: "ps-219fa02f5b4242af8", + # phone: "5555555555", + # profile_id: "p-60fbc37c87f04fce9", + # trading_partner_id: "tp-2a17ca447f6f4a8a8", + # } + # # @example Request syntax with placeholder values # # resp = client.create_partnership({ @@ -629,6 +738,37 @@ def create_partnership(params = {}, options = {}) # * {Types::CreateProfileResponse#log_group_name #log_group_name} => String # * {Types::CreateProfileResponse#created_at #created_at} => Time # + # + # @example Example: Sample CreateProfile call + # + # resp = client.create_profile({ + # name: "Shipping Profile", + # business_name: "John's Shipping", + # client_token: "foo", + # email: "john@example.com", + # logging: "ENABLED", + # phone: "5555555555", + # tags: [ + # { + # key: "sampleKey", + # value: "sampleValue", + # }, + # ], + # }) + # + # resp.to_h outputs the following: + # { + # name: "Shipping Profile", + # business_name: "John's Trucking", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # email: "john@example.com", + # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", + # logging: "ENABLED", + # phone: "5555555555", + # profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + # profile_id: "p-60fbc37c87f04fce9", + # } + # # @example Request syntax with placeholder values # # resp = client.create_profile({ @@ -716,6 +856,47 @@ def create_profile(params = {}, options = {}) # * {Types::CreateTransformerResponse#sample_document #sample_document} => String # * {Types::CreateTransformerResponse#created_at #created_at} => Time # + # + # @example Example: Sample CreateTransformer call + # + # resp = client.create_transformer({ + # name: "transformJSON", + # client_token: "foo", + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # mapping_template: "{}", + # sample_document: "s3://test-bucket/sampleDoc.txt", + # tags: [ + # { + # key: "sampleKey", + # value: "sampleValue", + # }, + # ], + # }) + # + # resp.to_h outputs the following: + # { + # name: "transformJSON", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # mapping_template: "$", + # sample_document: "s3://test-bucket/sampleDoc.txt", + # status: "inactive", + # transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", + # transformer_id: "tr-974c129999f84d8c9", + # } + # # @example Request syntax with placeholder values # # resp = client.create_transformer({ @@ -769,6 +950,13 @@ def create_transformer(params = {}, options = {}) # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # + # @example Example: Sample DeleteCapabilty call + # + # resp = client.delete_capability({ + # capability_id: "ca-963a8121e4fc4e348", + # }) + # # @example Request syntax with placeholder values # # resp = client.delete_capability({ @@ -793,6 +981,13 @@ def delete_capability(params = {}, options = {}) # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # + # @example Example: Sample DeletePartnership call + # + # resp = client.delete_partnership({ + # partnership_id: "ps-219fa02f5b4242af8", + # }) + # # @example Request syntax with placeholder values # # resp = client.delete_partnership({ @@ -816,6 +1011,13 @@ def delete_partnership(params = {}, options = {}) # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # + # @example Example: Sample DeleteProfile call + # + # resp = client.delete_profile({ + # profile_id: "p-60fbc37c87f04fce9", + # }) + # # @example Request syntax with placeholder values # # resp = client.delete_profile({ @@ -840,6 +1042,13 @@ def delete_profile(params = {}, options = {}) # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # + # @example Example: Sample DeleteTransformer call + # + # resp = client.delete_transformer({ + # transformer_id: "tr-974c129999f84d8c9", + # }) + # # @example Request syntax with placeholder values # # resp = client.delete_transformer({ @@ -873,6 +1082,48 @@ def delete_transformer(params = {}, options = {}) # * {Types::GetCapabilityResponse#created_at #created_at} => Time # * {Types::GetCapabilityResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample GetCapabilty call + # + # resp = client.get_capability({ + # capability_id: "ca-963a8121e4fc4e348", + # }) + # + # resp.to_h outputs the following: + # { + # name: "b2biexample", + # type: "edi", + # capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + # capability_id: "ca-963a8121e4fc4e348", + # configuration: { + # edi: { + # type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # input_location: { + # key: "input/", + # bucket_name: "test-bucket", + # }, + # output_location: { + # key: "output/", + # bucket_name: "test-bucket", + # }, + # transformer_id: "tr-9a893cf536df4658b", + # }, + # }, + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # instructions_documents: [ + # { + # key: "instructiondoc.txt", + # bucket_name: "test-bucket", + # }, + # ], + # modified_at: Time.parse("2023-11-02T21:51:05.504Z"), + # } + # # @example Request syntax with placeholder values # # resp = client.get_capability({ @@ -928,6 +1179,29 @@ def get_capability(params = {}, options = {}) # * {Types::GetPartnershipResponse#created_at #created_at} => Time # * {Types::GetPartnershipResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample GetPartnership call + # + # resp = client.get_partnership({ + # partnership_id: "ps-219fa02f5b4242af8", + # }) + # + # resp.to_h outputs the following: + # { + # name: "b2bipartner", + # capabilities: [ + # "ca-963a8121e4fc4e348", + # ], + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # email: "john@example.com", + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8", + # partnership_id: "ps-219fa02f5b4242af8", + # phone: "5555555555", + # profile_id: "p-60fbc37c87f04fce9", + # trading_partner_id: "tp-2a17ca447f6f4a8a8", + # } + # # @example Request syntax with placeholder values # # resp = client.get_partnership({ @@ -977,6 +1251,26 @@ def get_partnership(params = {}, options = {}) # * {Types::GetProfileResponse#created_at #created_at} => Time # * {Types::GetProfileResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample GetProfile call + # + # resp = client.get_profile({ + # profile_id: "p-60fbc37c87f04fce9", + # }) + # + # resp.to_h outputs the following: + # { + # name: "Shipping Profile", + # business_name: "John's Trucking", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # email: "john@example.com", + # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", + # logging: "ENABLED", + # phone: "5555555555", + # profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + # profile_id: "p-60fbc37c87f04fce9", + # } + # # @example Request syntax with placeholder values # # resp = client.get_profile({ @@ -1025,6 +1319,32 @@ def get_profile(params = {}, options = {}) # * {Types::GetTransformerResponse#created_at #created_at} => Time # * {Types::GetTransformerResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample GetTransformer call + # + # resp = client.get_transformer({ + # transformer_id: "tr-974c129999f84d8c9", + # }) + # + # resp.to_h outputs the following: + # { + # name: "transformJSON", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # mapping_template: "$", + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # sample_document: "s3://test-bucket/sampleDoc.txt", + # status: "inactive", + # transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", + # transformer_id: "tr-974c129999f84d8c9", + # } + # # @example Request syntax with placeholder values # # resp = client.get_transformer({ @@ -1070,6 +1390,26 @@ def get_transformer(params = {}, options = {}) # * {Types::GetTransformerJobResponse#output_files #output_files} => Array<Types::S3Location> # * {Types::GetTransformerJobResponse#message #message} => String # + # + # @example Example: Sample GetTransformerJob call + # + # resp = client.get_transformer_job({ + # transformer_id: "tr-974c129999f84d8c9", + # transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw", + # }) + # + # resp.to_h outputs the following: + # { + # message: "Transformed, writing output", + # output_files: [ + # { + # key: "output/sample-214.edi.2023-11-01T10:44:03.353Z.json", + # bucket_name: "gt-edi-test", + # }, + # ], + # status: "succeeded", + # } + # # @example Request syntax with placeholder values # # resp = client.get_transformer_job({ @@ -1115,6 +1455,28 @@ def get_transformer_job(params = {}, options = {}) # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # + # @example Example: Sample ListCapabilities call + # + # resp = client.list_capabilities({ + # max_results: 50, + # next_token: "foo", + # }) + # + # resp.to_h outputs the following: + # { + # capabilities: [ + # { + # name: "b2biexample", + # type: "edi", + # capability_id: "ca-963a8121e4fc4e348", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # }, + # ], + # next_token: "foo", + # } + # # @example Request syntax with placeholder values # # resp = client.list_capabilities({ @@ -1166,6 +1528,33 @@ def list_capabilities(params = {}, options = {}) # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # + # @example Example: Sample ListPartnerships call + # + # resp = client.list_partnerships({ + # max_results: 50, + # next_token: "foo", + # profile_id: "p-60fbc37c87f04fce9", + # }) + # + # resp.to_h outputs the following: + # { + # next_token: "string", + # partnerships: [ + # { + # name: "b2bipartner", + # capabilities: [ + # "ca-963a8121e4fc4e348", + # ], + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # partnership_id: "ps-219fa02f5b4242af8", + # profile_id: "p-60fbc37c87f04fce9", + # trading_partner_id: "tp-2a17ca447f6f4a8a8", + # }, + # ], + # } + # # @example Request syntax with placeholder values # # resp = client.list_partnerships({ @@ -1216,6 +1605,29 @@ def list_partnerships(params = {}, options = {}) # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # + # @example Example: Sample ListProfiles call + # + # resp = client.list_profiles({ + # max_results: 50, + # next_token: "foo", + # }) + # + # resp.to_h outputs the following: + # { + # next_token: "foo", + # profiles: [ + # { + # name: "Shipping Profile", + # business_name: "John's Trucking", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", + # logging: "ENABLED", + # profile_id: "p-60fbc37c87f04fce9", + # }, + # ], + # } + # # @example Request syntax with placeholder values # # resp = client.list_profiles({ @@ -1257,6 +1669,23 @@ def list_profiles(params = {}, options = {}) # # * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag> # + # + # @example Example: Sample ListTagsForResources call + # + # resp = client.list_tags_for_resource({ + # resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + # }) + # + # resp.to_h outputs the following: + # { + # tags: [ + # { + # key: "sampleKey", + # value: "SampleValue", + # }, + # ], + # } + # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ @@ -1298,6 +1727,37 @@ def list_tags_for_resource(params = {}, options = {}) # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # + # @example Example: Sample ListTransformers call + # + # resp = client.list_transformers({ + # max_results: 50, + # next_token: "foo", + # }) + # + # resp.to_h outputs the following: + # { + # next_token: "foo", + # transformers: [ + # { + # name: "transformJSON", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # mapping_template: "$", + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # sample_document: "s3://test-bucket/sampleDoc.txt", + # status: "inactive", + # transformer_id: "tr-974c129999f84d8c9", + # }, + # ], + # } + # # @example Request syntax with placeholder values # # resp = client.list_transformers({ @@ -1359,6 +1819,27 @@ def list_transformers(params = {}, options = {}) # # * {Types::StartTransformerJobResponse#transformer_job_id #transformer_job_id} => String # + # + # @example Example: Sample StartTransformerJob call + # + # resp = client.start_transformer_job({ + # client_token: "foo", + # input_file: { + # key: "input/inputFile.txt", + # bucket_name: "test-bucket", + # }, + # output_location: { + # key: "output/", + # bucket_name: "test-bucket", + # }, + # transformer_id: "tr-974c129999f84d8c9", + # }) + # + # resp.to_h outputs the following: + # { + # transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw", + # } + # # @example Request syntax with placeholder values # # resp = client.start_transformer_job({ @@ -1405,6 +1886,19 @@ def start_transformer_job(params = {}, options = {}) # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # + # @example Example: Sample TagResource call + # + # resp = client.tag_resource({ + # resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + # tags: [ + # { + # key: "sampleKey", + # value: "SampleValue", + # }, + # ], + # }) + # # @example Request syntax with placeholder values # # resp = client.tag_resource({ @@ -1448,6 +1942,20 @@ def tag_resource(params = {}, options = {}) # # * {Types::TestMappingResponse#mapped_file_content #mapped_file_content} => String # + # + # @example Example: Sample TestMapping call + # + # resp = client.test_mapping({ + # file_format: "JSON", + # input_file_content: "Sample file content", + # mapping_template: "$", + # }) + # + # resp.to_h outputs the following: + # { + # mapped_file_content: "Sample file content", + # } + # # @example Request syntax with placeholder values # # resp = client.test_mapping({ @@ -1469,7 +1977,8 @@ def test_mapping(params = {}, options = {}) req.send_request(options) end - # Parses the input EDI (electronic data interchange) file. + # Parses the input EDI (electronic data interchange) file. The input + # file has a file size limit of 250 KB. # # @option params [required, Types::S3Location] :input_file # Specifies an `S3Location` object, which contains the Amazon S3 bucket @@ -1489,6 +1998,28 @@ def test_mapping(params = {}, options = {}) # # * {Types::TestParsingResponse#parsed_file_content #parsed_file_content} => String # + # + # @example Example: Sample TestParsing call + # + # resp = client.test_parsing({ + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # input_file: { + # key: "sampleFile.txt", + # bucket_name: "test-bucket", + # }, + # }) + # + # resp.to_h outputs the following: + # { + # parsed_file_content: "Sample parsed file content", + # } + # # @example Request syntax with placeholder values # # resp = client.test_parsing({ @@ -1534,6 +2065,16 @@ def test_parsing(params = {}, options = {}) # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # + # @example Example: Sample UntagResource call + # + # resp = client.untag_resource({ + # resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + # tag_keys: [ + # "sampleKey", + # ], + # }) + # # @example Request syntax with placeholder values # # resp = client.untag_resource({ @@ -1579,6 +2120,74 @@ def untag_resource(params = {}, options = {}) # * {Types::UpdateCapabilityResponse#created_at #created_at} => Time # * {Types::UpdateCapabilityResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample UpdateCapability call + # + # resp = client.update_capability({ + # name: "b2biexample", + # capability_id: "ca-963a8121e4fc4e348", + # configuration: { + # edi: { + # type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # input_location: { + # key: "input/", + # bucket_name: "test-bucket", + # }, + # output_location: { + # key: "output/", + # bucket_name: "test-bucket", + # }, + # transformer_id: "tr-9a893cf536df4658b", + # }, + # }, + # instructions_documents: [ + # { + # key: "instructiondoc.txt", + # bucket_name: "test-bucket", + # }, + # ], + # }) + # + # resp.to_h outputs the following: + # { + # name: "b2biexample", + # type: "edi", + # capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + # capability_id: "ca-963a8121e4fc4e348", + # configuration: { + # edi: { + # type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # input_location: { + # key: "input/", + # bucket_name: "test-bucket", + # }, + # output_location: { + # key: "output/", + # bucket_name: "test-bucket", + # }, + # transformer_id: "tr-9a893cf536df4658b", + # }, + # }, + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # instructions_documents: [ + # { + # key: "instructiondoc.txt", + # bucket_name: "test-bucket", + # }, + # ], + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # } + # # @example Request syntax with placeholder values # # resp = client.update_capability({ @@ -1666,6 +2275,33 @@ def update_capability(params = {}, options = {}) # * {Types::UpdatePartnershipResponse#created_at #created_at} => Time # * {Types::UpdatePartnershipResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample UpdatePartnership call + # + # resp = client.update_partnership({ + # name: "b2bipartner", + # capabilities: [ + # "ca-963a8121e4fc4e348", + # ], + # partnership_id: "ps-219fa02f5b4242af8", + # }) + # + # resp.to_h outputs the following: + # { + # name: "b2bipartner", + # capabilities: [ + # "ca-963a8121e4fc4e348", + # ], + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # email: "john@example.com", + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", + # partnership_id: "ps-219fa02f5b4242af8", + # phone: "5555555555", + # profile_id: "p-60fbc37c87f04fce9", + # trading_partner_id: "tp-2a17ca447f6f4a8a8", + # } + # # @example Request syntax with placeholder values # # resp = client.update_partnership({ @@ -1728,6 +2364,31 @@ def update_partnership(params = {}, options = {}) # * {Types::UpdateProfileResponse#created_at #created_at} => Time # * {Types::UpdateProfileResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample UpdateProfile call + # + # resp = client.update_profile({ + # name: "Shipping Profile", + # business_name: "John's Shipping", + # email: "john@example.com", + # phone: "5555555555", + # profile_id: "p-60fbc37c87f04fce9", + # }) + # + # resp.to_h outputs the following: + # { + # name: "Shipping Profile", + # business_name: "John's Trucking", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # email: "john@example.com", + # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", + # logging: "ENABLED", + # modified_at: Time.parse("2023-11-02T21:51:05.504Z"), + # phone: "5555555555", + # profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + # profile_id: "p-60fbc37c87f04fce9", + # } + # # @example Request syntax with placeholder values # # resp = client.update_profile({ @@ -1806,6 +2467,43 @@ def update_profile(params = {}, options = {}) # * {Types::UpdateTransformerResponse#created_at #created_at} => Time # * {Types::UpdateTransformerResponse#modified_at #modified_at} => Time # + # + # @example Example: Sample UpdateTransformer call + # + # resp = client.update_transformer({ + # name: "transformJSON", + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # mapping_template: "{}", + # sample_document: "s3://test-bucket/sampleDoc.txt", + # status: "inactive", + # transformer_id: "tr-974c129999f84d8c9", + # }) + # + # resp.to_h outputs the following: + # { + # name: "transformJSON", + # created_at: Time.parse("2023-11-01T21:51:05.504Z"), + # edi_type: { + # x12_details: { + # version: "VERSION_4010", + # transaction_set: "X12_110", + # }, + # }, + # file_format: "JSON", + # mapping_template: "$", + # modified_at: Time.parse("2023-11-01T21:51:05.504Z"), + # sample_document: "s3://test-bucket/sampleDoc.txt", + # status: "inactive", + # transformer_arn: "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", + # transformer_id: "tr-974c129999f84d8c9", + # } + # # @example Request syntax with placeholder values # # resp = client.update_transformer({ @@ -1859,7 +2557,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-b2bi' - context[:gem_version] = '1.2.0' + context[:gem_version] = '1.3.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client_api.rb b/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client_api.rb index ceea35476a4..ddda1e9f662 100644 --- a/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client_api.rb +++ b/gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client_api.rb @@ -793,6 +793,7 @@ module ClientApi o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceResponse) o.errors << Shapes::ShapeRef.new(shape: ValidationException) o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) api.add_operation(:list_transformers, Seahorse::Model::Operation.new.tap do |o| @@ -831,6 +832,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: ValidationException) o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) api.add_operation(:test_mapping, Seahorse::Model::Operation.new.tap do |o| @@ -867,6 +869,7 @@ module ClientApi o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure)) o.errors << Shapes::ShapeRef.new(shape: ValidationException) o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) api.add_operation(:update_capability, Seahorse::Model::Operation.new.tap do |o| diff --git a/gems/aws-sdk-cloudtrail/CHANGELOG.md b/gems/aws-sdk-cloudtrail/CHANGELOG.md index 4a8d7bd40f8..b99aaabfbb5 100644 --- a/gems/aws-sdk-cloudtrail/CHANGELOG.md +++ b/gems/aws-sdk-cloudtrail/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.75.0 (2024-01-18) +------------------ + +* Feature - This release adds a new API ListInsightsMetricData to retrieve metric data from CloudTrail Insights. + 1.74.0 (2023-11-28) ------------------ diff --git a/gems/aws-sdk-cloudtrail/VERSION b/gems/aws-sdk-cloudtrail/VERSION index dc87e8af82f..7c7053aa238 100644 --- a/gems/aws-sdk-cloudtrail/VERSION +++ b/gems/aws-sdk-cloudtrail/VERSION @@ -1 +1 @@ -1.74.0 +1.75.0 diff --git a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail.rb b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail.rb index 5b7d6d874c8..fb7cb5421ae 100644 --- a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail.rb +++ b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail.rb @@ -52,6 +52,6 @@ # @!group service module Aws::CloudTrail - GEM_VERSION = '1.74.0' + GEM_VERSION = '1.75.0' end diff --git a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb index 805faee4178..89c3c4849dd 100644 --- a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb +++ b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb @@ -862,11 +862,6 @@ def create_event_data_store(params = {}, options = {}) # # Not required unless you specify `CloudWatchLogsRoleArn`. # - # Only the management account can configure a CloudWatch Logs log group - # for an organization trail. - # - # - # # @option params [String] :cloud_watch_logs_role_arn # 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 @@ -1240,11 +1235,12 @@ def describe_trails(params = {}, options = {}) end # Disables Lake query federation on the specified event data store. When - # you disable federation, CloudTrail removes the metadata associated - # with the federated event data store in the Glue Data Catalog and - # removes registration for the federation role ARN and event data store - # in Lake Formation. No CloudTrail Lake data is deleted when you disable - # federation. + # 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. # # @option params [required, String] :event_data_store # The ARN (or ID suffix of the ARN) of the event data store for which @@ -1282,13 +1278,13 @@ def disable_federation(params = {}, options = {}) # 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 federated + # When you enable Lake query federation, CloudTrail creates a managed # database named `aws:cloudtrail` (if the database doesn't already - # exist) and a 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][2], the service responsible - # for revoking or granting permissions to the federated resources in the - # Glue Data Catalog. + # 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][2], 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][3]. @@ -1296,7 +1292,7 @@ def disable_federation(params = {}, options = {}) # # # [1]: https://docs.aws.amazon.com/glue/latest/dg/components-overview.html#data-catalog-intro - # [2]: https://docs.aws.amazon.com/lake-formation/latest/dg/how-it-works.html + # [2]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation-lake-formation.html # [3]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html # # @option params [required, String] :event_data_store @@ -2102,6 +2098,134 @@ def list_imports(params = {}, options = {}) req.send_request(options) end + # 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. + # + # * 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. + # + # Access to the `ListInsightsMetricData` API operation is linked to the + # `cloudtrail:LookupEvents` action. To use this operation, you must have + # permissions to perform the `cloudtrail:LookupEvents` action. + # + # @option params [required, String] :event_source + # The Amazon Web Services service to which the request was made, such as + # `iam.amazonaws.com` or `s3.amazonaws.com`. + # + # @option params [required, String] :event_name + # The name of the event, typically the Amazon Web Services API on which + # unusual levels of activity were recorded. + # + # @option params [required, String] :insight_type + # The type of CloudTrail Insights event, which is either + # `ApiCallRateInsight` or `ApiErrorRateInsight`. 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. + # + # @option params [String] :error_code + # 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`. + # + # @option params [Time,DateTime,Date,Integer,String] :start_time + # 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. + # + # @option params [Time,DateTime,Date,Integer,String] :end_time + # 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. + # + # @option params [Integer] :period + # Granularity of data to retrieve, in seconds. Valid values are `60`, + # `300`, and `3600`. If you specify any other value, you will get an + # error. The default is 3600 seconds. + # + # @option params [String] :data_type + # Type of datapoints to return. Valid values are `NonZeroData` and + # `FillWithZeros`. The default is `NonZeroData`. + # + # @option params [Integer] :max_results + # The maximum number of datapoints to return. Valid values are integers + # from 1 to 21600. The default value is 21600. + # + # @option params [String] :next_token + # 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. + # + # @return [Types::ListInsightsMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListInsightsMetricDataResponse#event_source #event_source} => String + # * {Types::ListInsightsMetricDataResponse#event_name #event_name} => String + # * {Types::ListInsightsMetricDataResponse#insight_type #insight_type} => String + # * {Types::ListInsightsMetricDataResponse#error_code #error_code} => String + # * {Types::ListInsightsMetricDataResponse#timestamps #timestamps} => Array<Time> + # * {Types::ListInsightsMetricDataResponse#values #values} => Array<Float> + # * {Types::ListInsightsMetricDataResponse#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_insights_metric_data({ + # event_source: "EventSource", # required + # event_name: "EventName", # required + # insight_type: "ApiCallRateInsight", # required, accepts ApiCallRateInsight, ApiErrorRateInsight + # error_code: "ErrorCode", + # start_time: Time.now, + # end_time: Time.now, + # period: 1, + # data_type: "FillWithZeros", # accepts FillWithZeros, NonZeroData + # max_results: 1, + # next_token: "InsightsMetricNextToken", + # }) + # + # @example Response structure + # + # resp.event_source #=> String + # resp.event_name #=> String + # resp.insight_type #=> String, one of "ApiCallRateInsight", "ApiErrorRateInsight" + # resp.error_code #=> String + # resp.timestamps #=> Array + # resp.timestamps[0] #=> Time + # resp.values #=> Array + # resp.values[0] #=> Float + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListInsightsMetricData AWS API Documentation + # + # @overload list_insights_metric_data(params = {}) + # @param [Hash] params ({}) + def list_insights_metric_data(params = {}, options = {}) + req = build_request(:list_insights_metric_data, params) + req.send_request(options) + end + # 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 @@ -3305,13 +3429,14 @@ def update_channel(params = {}, options = {}) # `TerminationProtection` is enabled. # # For event data stores for CloudTrail events, `AdvancedEventSelectors` - # includes or excludes management, data, or Insights events in your - # event data store. For more information about `AdvancedEventSelectors`, - # see [AdvancedEventSelectors][1]. + # includes or excludes management or data events in your event data + # store. For more information about `AdvancedEventSelectors`, see + # [AdvancedEventSelectors][1]. # - # For event data stores for Config configuration items, Audit Manager - # evidence, or non-Amazon Web Services events, `AdvancedEventSelectors` - # includes events of that type in your event data store. + # 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. # # # @@ -3609,11 +3734,6 @@ def update_event_data_store(params = {}, options = {}) # # Not required unless you specify `CloudWatchLogsRoleArn`. # - # Only the management account can configure a CloudWatch Logs log group - # for an organization trail. - # - # - # # @option params [String] :cloud_watch_logs_role_arn # 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 @@ -3731,7 +3851,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-cloudtrail' - context[:gem_version] = '1.74.0' + context[:gem_version] = '1.75.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client_api.rb b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client_api.rb index 41efdd41e91..94b74bd29c4 100644 --- a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client_api.rb +++ b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client_api.rb @@ -78,8 +78,10 @@ module ClientApi Destinations = Shapes::ListShape.new(name: 'Destinations') DisableFederationRequest = Shapes::StructureShape.new(name: 'DisableFederationRequest') DisableFederationResponse = Shapes::StructureShape.new(name: 'DisableFederationResponse') + Double = Shapes::FloatShape.new(name: 'Double') EnableFederationRequest = Shapes::StructureShape.new(name: 'EnableFederationRequest') EnableFederationResponse = Shapes::StructureShape.new(name: 'EnableFederationResponse') + ErrorCode = Shapes::StringShape.new(name: 'ErrorCode') ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage') Event = Shapes::StructureShape.new(name: 'Event') EventCategory = Shapes::StringShape.new(name: 'EventCategory') @@ -96,8 +98,10 @@ module ClientApi EventDataStoreStatus = Shapes::StringShape.new(name: 'EventDataStoreStatus') EventDataStoreTerminationProtectedException = Shapes::StructureShape.new(name: 'EventDataStoreTerminationProtectedException') EventDataStores = Shapes::ListShape.new(name: 'EventDataStores') + EventName = Shapes::StringShape.new(name: 'EventName') EventSelector = Shapes::StructureShape.new(name: 'EventSelector') EventSelectors = Shapes::ListShape.new(name: 'EventSelectors') + EventSource = Shapes::StringShape.new(name: 'EventSource') EventsList = Shapes::ListShape.new(name: 'EventsList') ExcludeManagementEventSources = Shapes::ListShape.new(name: 'ExcludeManagementEventSources') FederationRoleArn = Shapes::StringShape.new(name: 'FederationRoleArn') @@ -137,6 +141,11 @@ module ClientApi InsightSelector = Shapes::StructureShape.new(name: 'InsightSelector') InsightSelectors = Shapes::ListShape.new(name: 'InsightSelectors') InsightType = Shapes::StringShape.new(name: 'InsightType') + InsightsMetricDataType = Shapes::StringShape.new(name: 'InsightsMetricDataType') + InsightsMetricMaxResults = Shapes::IntegerShape.new(name: 'InsightsMetricMaxResults') + InsightsMetricNextToken = Shapes::StringShape.new(name: 'InsightsMetricNextToken') + InsightsMetricPeriod = Shapes::IntegerShape.new(name: 'InsightsMetricPeriod') + InsightsMetricValues = Shapes::ListShape.new(name: 'InsightsMetricValues') InsufficientDependencyServiceAccessPermissionException = Shapes::StructureShape.new(name: 'InsufficientDependencyServiceAccessPermissionException') InsufficientEncryptionPolicyException = Shapes::StructureShape.new(name: 'InsufficientEncryptionPolicyException') InsufficientS3BucketPolicyException = Shapes::StructureShape.new(name: 'InsufficientS3BucketPolicyException') @@ -183,6 +192,8 @@ module ClientApi ListImportsMaxResultsCount = Shapes::IntegerShape.new(name: 'ListImportsMaxResultsCount') ListImportsRequest = Shapes::StructureShape.new(name: 'ListImportsRequest') ListImportsResponse = Shapes::StructureShape.new(name: 'ListImportsResponse') + ListInsightsMetricDataRequest = Shapes::StructureShape.new(name: 'ListInsightsMetricDataRequest') + ListInsightsMetricDataResponse = Shapes::StructureShape.new(name: 'ListInsightsMetricDataResponse') ListPublicKeysRequest = Shapes::StructureShape.new(name: 'ListPublicKeysRequest') ListPublicKeysResponse = Shapes::StructureShape.new(name: 'ListPublicKeysResponse') ListQueriesMaxResultsCount = Shapes::IntegerShape.new(name: 'ListQueriesMaxResultsCount') @@ -285,6 +296,7 @@ module ClientApi TagsList = Shapes::ListShape.new(name: 'TagsList') TerminationProtectionEnabled = Shapes::BooleanShape.new(name: 'TerminationProtectionEnabled') ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException') + Timestamps = Shapes::ListShape.new(name: 'Timestamps') Trail = Shapes::StructureShape.new(name: 'Trail') TrailAlreadyExistsException = Shapes::StructureShape.new(name: 'TrailAlreadyExistsException') TrailInfo = Shapes::StructureShape.new(name: 'TrailInfo') @@ -731,6 +743,8 @@ module ClientApi InsightSelectors.member = Shapes::ShapeRef.new(shape: InsightSelector) + InsightsMetricValues.member = Shapes::ShapeRef.new(shape: Double) + InsufficientDependencyServiceAccessPermissionException.struct_class = Types::InsufficientDependencyServiceAccessPermissionException InsufficientEncryptionPolicyException.struct_class = Types::InsufficientEncryptionPolicyException @@ -832,6 +846,27 @@ module ClientApi ListImportsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken")) ListImportsResponse.struct_class = Types::ListImportsResponse + ListInsightsMetricDataRequest.add_member(:event_source, Shapes::ShapeRef.new(shape: EventSource, required: true, location_name: "EventSource")) + ListInsightsMetricDataRequest.add_member(:event_name, Shapes::ShapeRef.new(shape: EventName, required: true, location_name: "EventName")) + ListInsightsMetricDataRequest.add_member(:insight_type, Shapes::ShapeRef.new(shape: InsightType, required: true, location_name: "InsightType")) + ListInsightsMetricDataRequest.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode")) + ListInsightsMetricDataRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Date, location_name: "StartTime")) + ListInsightsMetricDataRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Date, location_name: "EndTime")) + ListInsightsMetricDataRequest.add_member(:period, Shapes::ShapeRef.new(shape: InsightsMetricPeriod, location_name: "Period")) + ListInsightsMetricDataRequest.add_member(:data_type, Shapes::ShapeRef.new(shape: InsightsMetricDataType, location_name: "DataType")) + ListInsightsMetricDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: InsightsMetricMaxResults, location_name: "MaxResults")) + ListInsightsMetricDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: InsightsMetricNextToken, location_name: "NextToken")) + ListInsightsMetricDataRequest.struct_class = Types::ListInsightsMetricDataRequest + + ListInsightsMetricDataResponse.add_member(:event_source, Shapes::ShapeRef.new(shape: EventSource, location_name: "EventSource")) + ListInsightsMetricDataResponse.add_member(:event_name, Shapes::ShapeRef.new(shape: EventName, location_name: "EventName")) + ListInsightsMetricDataResponse.add_member(:insight_type, Shapes::ShapeRef.new(shape: InsightType, location_name: "InsightType")) + ListInsightsMetricDataResponse.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode")) + ListInsightsMetricDataResponse.add_member(:timestamps, Shapes::ShapeRef.new(shape: Timestamps, location_name: "Timestamps")) + ListInsightsMetricDataResponse.add_member(:values, Shapes::ShapeRef.new(shape: InsightsMetricValues, location_name: "Values")) + ListInsightsMetricDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: InsightsMetricNextToken, location_name: "NextToken")) + ListInsightsMetricDataResponse.struct_class = Types::ListInsightsMetricDataResponse + ListPublicKeysRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Date, location_name: "StartTime")) ListPublicKeysRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Date, location_name: "EndTime")) ListPublicKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken")) @@ -1105,6 +1140,8 @@ module ClientApi ThrottlingException.struct_class = Types::ThrottlingException + Timestamps.member = Shapes::ShapeRef.new(shape: Date) + Trail.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name")) Trail.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: String, location_name: "S3BucketName")) Trail.add_member(:s3_key_prefix, Shapes::ShapeRef.new(shape: String, location_name: "S3KeyPrefix")) @@ -1720,6 +1757,23 @@ module ClientApi ) end) + api.add_operation(:list_insights_metric_data, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListInsightsMetricData" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ListInsightsMetricDataRequest) + o.output = Shapes::ShapeRef.new(shape: ListInsightsMetricDataResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException) + o.errors << Shapes::ShapeRef.new(shape: OperationNotPermittedException) + o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_public_keys, Seahorse::Model::Operation.new.tap do |o| o.name = "ListPublicKeys" o.http_method = "POST" diff --git a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/endpoints.rb b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/endpoints.rb index e679e54cb1e..4d13a2eae78 100644 --- a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/endpoints.rb +++ b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/endpoints.rb @@ -390,6 +390,20 @@ def self.build(context) end end + class ListInsightsMetricData + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::CloudTrail::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListPublicKeys def self.build(context) unless context.config.regional_endpoint diff --git a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/plugins/endpoints.rb b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/plugins/endpoints.rb index a833b09b330..61f982ca3f4 100644 --- a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/plugins/endpoints.rb +++ b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/plugins/endpoints.rb @@ -111,6 +111,8 @@ def parameters_for_operation(context) Aws::CloudTrail::Endpoints::ListImportFailures.build(context) when :list_imports Aws::CloudTrail::Endpoints::ListImports.build(context) + when :list_insights_metric_data + Aws::CloudTrail::Endpoints::ListInsightsMetricData.build(context) when :list_public_keys Aws::CloudTrail::Endpoints::ListPublicKeys.build(context) when :list_queries diff --git a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb index b7cf8a1a494..093ea1e312b 100644 --- a/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb +++ b/gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb @@ -127,17 +127,20 @@ class AdvancedEventSelector < Struct.new( # # @!attribute [rw] field # A field in a CloudTrail event record on which to filter events to be - # logged. For event data stores for Config configuration items, Audit - # Manager evidence, or non-Amazon Web Services events, the field is - # used only for selecting events as filtering is not supported. + # 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 event records, supported fields include `readOnly`, - # `eventCategory`, `eventSource` (for management events), `eventName`, - # `resources.type`, and `resources.ARN`. + # For CloudTrail management events, supported fields include + # `readOnly`, `eventCategory`, and `eventSource`. # - # For event data stores for Config configuration items, Audit Manager - # evidence, or non-Amazon Web Services events, the only supported - # field is `eventCategory`. + # 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, @@ -157,11 +160,14 @@ class AdvancedEventSelector < Struct.new( # * eventCategory - This is required and must be # set to `Equals`. # - # * For CloudTrail event records, the value must be `Management` or - # `Data`. + # * For CloudTrail management events, the value must be + # `Management`. + # + # * For CloudTrail data events, the value must be `Data`. # - # * For CloudTrail Insights event records, the value must be - # `Insight`. + # 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`. @@ -181,6 +187,16 @@ class AdvancedEventSelector < Struct.new( # # * `AWS::S3::Object` # + # * `AWS::B2BI::Transformer` + # + # * `AWS::Bedrock::AgentAlias` + # + # * `AWS::Bedrock::KnowledgeBase` + # + # * `AWS::Cassandra::Table` + # + # * `AWS::CloudFront::KeyValueStore` + # # * `AWS::CloudTrail::Channel` # # * `AWS::CodeWhisperer::Customization` @@ -201,6 +217,10 @@ class AdvancedEventSelector < Struct.new( # # * `AWS::GuardDuty::Detector` # + # * `AWS::IoTTwinMaker::Entity` + # + # * `AWS::IoTTwinMaker::Workspace` + # # * `AWS::KendraRanking::ExecutionPlan` # # * `AWS::KinesisVideo::Stream` @@ -211,18 +231,38 @@ class AdvancedEventSelector < Struct.new( # # * `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::SageMaker::Endpoint` # # * `AWS::SageMaker::ExperimentTrialComponent` # # * `AWS::SageMaker::FeatureGroup` # + # * `AWS::ServiceDiscovery::Namespace ` + # + # * `AWS::ServiceDiscovery::Service` + # + # * `AWS::SCN::Instance` + # # * `AWS::SNS::PlatformEndpoint` # # * `AWS::SNS::Topic` # + # * `AWS::SQS::Queue` + # # * `AWS::S3::AccessPoint` # # * `AWS::S3ObjectLambda::AccessPoint` @@ -231,6 +271,10 @@ class AdvancedEventSelector < Struct.new( # # * `AWS::SSMMessages::ControlChannel` # + # * `AWS::ThinClient::Device` + # + # * `AWS::ThinClient::Environment` + # # * `AWS::Timestream::Database` # # * `AWS::Timestream::Table` @@ -273,6 +317,46 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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: @@ -325,7 +409,7 @@ class AdvancedEventSelector < Struct.new( # operator is set to `Equals` or `NotEquals`, the ARN must be in the # following format: # - # * `arn::emrwal:::workspace/` + # * `arn::emrwal:::workspace/` # # ^ # @@ -353,6 +437,22 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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: @@ -365,7 +465,7 @@ class AdvancedEventSelector < Struct.new( # operator is set to `Equals` or `NotEquals`, the ARN must be in the # following format: # - # * `arn::kinesisvideo:::stream/` + # * `arn::kinesisvideo:::stream//` # # ^ # @@ -393,6 +493,14 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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: @@ -401,6 +509,46 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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::SageMaker::Endpoint`, and the # operator is set to `Equals` or `NotEquals`, the ARN must be in the # following format: @@ -426,6 +574,30 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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: @@ -442,6 +614,14 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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::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 @@ -477,6 +657,22 @@ class AdvancedEventSelector < Struct.new( # # ^ # + # 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: @@ -1106,11 +1302,6 @@ class CreateEventDataStoreResponse < Struct.new( # account. # # Not required unless you specify `CloudWatchLogsRoleArn`. - # - # Only the management account can configure a CloudWatch Logs log - # group for an organization trail. - # - # # @return [String] # # @!attribute [rw] cloud_watch_logs_role_arn @@ -1339,67 +1530,9 @@ class CreateTrailResponse < Struct.new( # # * `AWS::S3::Object` # - # The following resource types are also available through *advanced* - # event selectors. Basic event selector resource types are valid in - # advanced event selectors, but advanced event selector resource types - # are not valid in basic event selectors. For more information, see - # [AdvancedFieldSelector][1]. - # - # * `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::GuardDuty::Detector` - # - # * `AWS::KendraRanking::ExecutionPlan` - # - # * `AWS::KinesisVideo::Stream` - # - # * `AWS::ManagedBlockchain::Network` - # - # * `AWS::ManagedBlockchain::Node` - # - # * `AWS::MedicalImaging::Datastore` - # - # * `AWS::PCAConnectorAD::Connector` - # - # * `AWS::SageMaker::Endpoint` - # - # * `AWS::SageMaker::ExperimentTrialComponent` - # - # * `AWS::SageMaker::FeatureGroup` - # - # * `AWS::SNS::PlatformEndpoint` - # - # * `AWS::SNS::Topic` - # - # * `AWS::S3::AccessPoint` - # - # * `AWS::S3ObjectLambda::AccessPoint` - # - # * `AWS::S3Outposts::Object` - # - # * `AWS::SSMMessages::ControlChannel` - # - # * `AWS::Timestream::Database` - # - # * `AWS::Timestream::Table` - # - # * `AWS::VerifiedPermissions::PolicyStore` + # Additional resource types are available through *advanced* event + # selectors. For more information about these additional resource + # types, see [AdvancedFieldSelector][1]. # # # @@ -1712,7 +1845,7 @@ class DescribeTrailsResponse < Struct.new( # @!attribute [rw] type # The type of destination for events arriving from a channel. For # channels used for a CloudTrail Lake integration, the value is - # `EventDataStore`. For service-linked channels, the value is + # `EVENT_DATA_STORE`. For service-linked channels, the value is # `AWS_SERVICE`. # @return [String] # @@ -3371,6 +3504,148 @@ class ListImportsResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] event_source + # The Amazon Web Services service to which the request was made, such + # as `iam.amazonaws.com` or `s3.amazonaws.com`. + # @return [String] + # + # @!attribute [rw] event_name + # The name of the event, typically the Amazon Web Services API on + # which unusual levels of activity were recorded. + # @return [String] + # + # @!attribute [rw] insight_type + # The type of CloudTrail Insights event, which is either + # `ApiCallRateInsight` or `ApiErrorRateInsight`. 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. + # @return [String] + # + # @!attribute [rw] error_code + # 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`. + # @return [String] + # + # @!attribute [rw] start_time + # 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. + # @return [Time] + # + # @!attribute [rw] end_time + # 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. + # @return [Time] + # + # @!attribute [rw] period + # Granularity of data to retrieve, in seconds. Valid values are `60`, + # `300`, and `3600`. If you specify any other value, you will get an + # error. The default is 3600 seconds. + # @return [Integer] + # + # @!attribute [rw] data_type + # Type of datapoints to return. Valid values are `NonZeroData` and + # `FillWithZeros`. The default is `NonZeroData`. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum number of datapoints to return. Valid values are + # integers from 1 to 21600. The default value is 21600. + # @return [Integer] + # + # @!attribute [rw] next_token + # 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. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListInsightsMetricDataRequest AWS API Documentation + # + class ListInsightsMetricDataRequest < Struct.new( + :event_source, + :event_name, + :insight_type, + :error_code, + :start_time, + :end_time, + :period, + :data_type, + :max_results, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] event_source + # The Amazon Web Services service to which the request was made, such + # as `iam.amazonaws.com` or `s3.amazonaws.com`. + # @return [String] + # + # @!attribute [rw] event_name + # The name of the event, typically the Amazon Web Services API on + # which unusual levels of activity were recorded. + # @return [String] + # + # @!attribute [rw] insight_type + # The type of CloudTrail Insights event, which is either + # `ApiCallRateInsight` or `ApiErrorRateInsight`. 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. + # @return [String] + # + # @!attribute [rw] error_code + # 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`. + # @return [String] + # + # @!attribute [rw] timestamps + # List of timestamps at intervals corresponding to the specified time + # period. + # @return [Array