diff --git a/.changes/2.1387.0.json b/.changes/2.1387.0.json new file mode 100644 index 0000000000..b7410d8e8d --- /dev/null +++ b/.changes/2.1387.0.json @@ -0,0 +1,52 @@ +[ + { + "type": "feature", + "category": "ChimeSDKVoice", + "description": "Added optional CallLeg field to StartSpeakerSearchTask API request" + }, + { + "type": "feature", + "category": "Glue", + "description": "Added Runtime parameter to allow selection of Ray Runtime" + }, + { + "type": "feature", + "category": "IoTFleetWise", + "description": "Campaigns now support selecting Timestream or S3 as the data destination, Signal catalogs now support \"Deprecation\" keyword released in VSS v2.1 and \"Comment\" keyword released in VSS v3.0" + }, + { + "type": "feature", + "category": "Location", + "description": "This release adds API support for political views for the maps service APIs: CreateMap, UpdateMap, DescribeMap." + }, + { + "type": "feature", + "category": "MemoryDB", + "description": "Amazon MemoryDB for Redis now supports AWS Identity and Access Management authentication access to Redis clusters starting with redis-engine version 7.0" + }, + { + "type": "feature", + "category": "Personalize", + "description": "This release provides support for the exclusion of certain columns for training when creating a solution and creating or updating a recommender with Amazon Personalize." + }, + { + "type": "feature", + "category": "Polly", + "description": "Amazon Polly adds 2 new voices - Sofie (da-DK) and Niamh (en-IE)" + }, + { + "type": "feature", + "category": "SecurityHub", + "description": "Added new resource detail objects to ASFF, including resources for AwsGuardDutyDetector, AwsAmazonMqBroker, AwsEventSchemasRegistry, AwsAppSyncGraphQlApi and AwsStepFunctionStateMachine." + }, + { + "type": "feature", + "category": "SecurityLake", + "description": "Log sources are now versioned. AWS log sources and custom sources will now come with a version identifier that enables producers to vend multiple schema versions to subscribers. Security Lake API have been refactored to more closely align with AWS API conventions." + }, + { + "type": "feature", + "category": "WAFV2", + "description": "This SDK release provides customers the ability to use Header Order as a field to match." + } +] \ No newline at end of file diff --git a/.changes/2.1388.0.json b/.changes/2.1388.0.json new file mode 100644 index 0000000000..8206fedc44 --- /dev/null +++ b/.changes/2.1388.0.json @@ -0,0 +1,32 @@ +[ + { + "type": "feature", + "category": "ConfigService", + "description": "Resource Types Exclusion feature launch by AWS Config" + }, + { + "type": "feature", + "category": "FraudDetector", + "description": "This release enables publishing event predictions from Amazon Fraud Detector (AFD) to Amazon EventBridge. For example, after getting predictions from AFD, Amazon EventBridge rules can be configured to trigger notification through an SNS topic, send a message with SES, or trigger Lambda workflows." + }, + { + "type": "feature", + "category": "HealthLake", + "description": "This release adds a new request parameter to the CreateFHIRDatastore API operation. IdentityProviderConfiguration specifies how you want to authenticate incoming requests to your Healthlake Data Store." + }, + { + "type": "feature", + "category": "M2", + "description": "Adds an optional create-only 'roleArn' property to Application resources. Enables PS and PO data set org types." + }, + { + "type": "feature", + "category": "RDS", + "description": "This release adds support for changing the engine for Oracle using the ModifyDbInstance API" + }, + { + "type": "feature", + "category": "WorkSpacesWeb", + "description": "WorkSpaces Web now allows you to control which IP addresses your WorkSpaces Web portal may be accessed from." + } +] \ No newline at end of file diff --git a/.changes/2.1389.0.json b/.changes/2.1389.0.json new file mode 100644 index 0000000000..08ae7f230a --- /dev/null +++ b/.changes/2.1389.0.json @@ -0,0 +1,22 @@ +[ + { + "type": "bugfix", + "category": "amazonprometheus", + "description": "Enable CORS for Amazon Prometheus" + }, + { + "type": "feature", + "category": "Appflow", + "description": "Added ability to select DataTransferApiType for DescribeConnector and CreateFlow requests when using Async supported connectors. Added supportedDataTransferType to DescribeConnector/DescribeConnectors/ListConnector response." + }, + { + "type": "feature", + "category": "CustomerProfiles", + "description": "This release introduces calculated attribute related APIs." + }, + { + "type": "feature", + "category": "IVS", + "description": "API Update for IVS Advanced Channel type" + } +] \ No newline at end of file diff --git a/.changes/2.1390.0.json b/.changes/2.1390.0.json new file mode 100644 index 0000000000..4bdec0d559 --- /dev/null +++ b/.changes/2.1390.0.json @@ -0,0 +1,22 @@ +[ + { + "type": "feature", + "category": "Athena", + "description": "This release introduces the DeleteCapacityReservation API and the ability to manage capacity reservations using CloudFormation" + }, + { + "type": "feature", + "category": "CloudTrail", + "description": "This feature allows users to start and stop event ingestion on a CloudTrail Lake event data store." + }, + { + "type": "feature", + "category": "SageMaker", + "description": "This release adds Selective Execution feature that allows SageMaker Pipelines users to run selected steps in a pipeline." + }, + { + "type": "feature", + "category": "WAFV2", + "description": "Added APIs to describe managed products. The APIs retrieve information about rule groups that are managed by AWS and by AWS Marketplace sellers." + } +] \ No newline at end of file diff --git a/.changes/2.1391.0.json b/.changes/2.1391.0.json new file mode 100644 index 0000000000..66da6220d6 --- /dev/null +++ b/.changes/2.1391.0.json @@ -0,0 +1,42 @@ +[ + { + "type": "feature", + "category": "CloudFormation", + "description": "AWS CloudFormation StackSets provides customers with three new APIs to activate, deactivate, and describe AWS Organizations trusted access which is needed to get started with service-managed StackSets." + }, + { + "type": "feature", + "category": "EC2", + "description": "Making InstanceTagAttribute as the required parameter for the DeregisterInstanceEventNotificationAttributes and RegisterInstanceEventNotificationAttributes APIs." + }, + { + "type": "feature", + "category": "Finspace", + "description": "Releasing new Managed kdb Insights APIs" + }, + { + "type": "feature", + "category": "FraudDetector", + "description": "Added new variable types, new DateTime data type, and new rules engine functions for interacting and working with DateTime data types." + }, + { + "type": "feature", + "category": "KMS", + "description": "This release includes feature to import customer's asymmetric (RSA and ECC) and HMAC keys into KMS. It also includes feature to allow customers to specify number of days to schedule a KMS key deletion as a policy condition key." + }, + { + "type": "feature", + "category": "Keyspaces", + "description": "This release adds support for MRR GA launch, and includes multiregion support in create-keyspace, get-keyspace, and list-keyspace." + }, + { + "type": "feature", + "category": "Lambda", + "description": "Add Ruby 3.2 (ruby3.2) Runtime support to AWS Lambda." + }, + { + "type": "feature", + "category": "MWAA", + "description": "This release adds ROLLING_BACK and CREATING_SNAPSHOT environment statuses for Amazon MWAA environments." + } +] \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d321d4bf0..5fc0722e08 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,49 @@ # Changelog for AWS SDK for JavaScript - + +## 2.1391.0 +* feature: CloudFormation: AWS CloudFormation StackSets provides customers with three new APIs to activate, deactivate, and describe AWS Organizations trusted access which is needed to get started with service-managed StackSets. +* feature: EC2: Making InstanceTagAttribute as the required parameter for the DeregisterInstanceEventNotificationAttributes and RegisterInstanceEventNotificationAttributes APIs. +* feature: Finspace: Releasing new Managed kdb Insights APIs +* feature: FraudDetector: Added new variable types, new DateTime data type, and new rules engine functions for interacting and working with DateTime data types. +* feature: KMS: This release includes feature to import customer's asymmetric (RSA and ECC) and HMAC keys into KMS. It also includes feature to allow customers to specify number of days to schedule a KMS key deletion as a policy condition key. +* feature: Keyspaces: This release adds support for MRR GA launch, and includes multiregion support in create-keyspace, get-keyspace, and list-keyspace. +* feature: Lambda: Add Ruby 3.2 (ruby3.2) Runtime support to AWS Lambda. +* feature: MWAA: This release adds ROLLING_BACK and CREATING_SNAPSHOT environment statuses for Amazon MWAA environments. + +## 2.1390.0 +* feature: Athena: This release introduces the DeleteCapacityReservation API and the ability to manage capacity reservations using CloudFormation +* feature: CloudTrail: This feature allows users to start and stop event ingestion on a CloudTrail Lake event data store. +* feature: SageMaker: This release adds Selective Execution feature that allows SageMaker Pipelines users to run selected steps in a pipeline. +* feature: WAFV2: Added APIs to describe managed products. The APIs retrieve information about rule groups that are managed by AWS and by AWS Marketplace sellers. + +## 2.1389.0 +* bugfix: amazonprometheus: Enable CORS for Amazon Prometheus +* feature: Appflow: Added ability to select DataTransferApiType for DescribeConnector and CreateFlow requests when using Async supported connectors. Added supportedDataTransferType to DescribeConnector/DescribeConnectors/ListConnector response. +* feature: CustomerProfiles: This release introduces calculated attribute related APIs. +* feature: IVS: API Update for IVS Advanced Channel type + +## 2.1388.0 +* feature: ConfigService: Resource Types Exclusion feature launch by AWS Config +* feature: FraudDetector: This release enables publishing event predictions from Amazon Fraud Detector (AFD) to Amazon EventBridge. For example, after getting predictions from AFD, Amazon EventBridge rules can be configured to trigger notification through an SNS topic, send a message with SES, or trigger Lambda workflows. +* feature: HealthLake: This release adds a new request parameter to the CreateFHIRDatastore API operation. IdentityProviderConfiguration specifies how you want to authenticate incoming requests to your Healthlake Data Store. +* feature: M2: Adds an optional create-only 'roleArn' property to Application resources. Enables PS and PO data set org types. +* feature: RDS: This release adds support for changing the engine for Oracle using the ModifyDbInstance API +* feature: WorkSpacesWeb: WorkSpaces Web now allows you to control which IP addresses your WorkSpaces Web portal may be accessed from. + +## 2.1387.0 +* feature: ChimeSDKVoice: Added optional CallLeg field to StartSpeakerSearchTask API request +* feature: Glue: Added Runtime parameter to allow selection of Ray Runtime +* feature: IoTFleetWise: Campaigns now support selecting Timestream or S3 as the data destination, Signal catalogs now support "Deprecation" keyword released in VSS v2.1 and "Comment" keyword released in VSS v3.0 +* feature: Location: This release adds API support for political views for the maps service APIs: CreateMap, UpdateMap, DescribeMap. +* feature: MemoryDB: Amazon MemoryDB for Redis now supports AWS Identity and Access Management authentication access to Redis clusters starting with redis-engine version 7.0 +* feature: Personalize: This release provides support for the exclusion of certain columns for training when creating a solution and creating or updating a recommender with Amazon Personalize. +* feature: Polly: Amazon Polly adds 2 new voices - Sofie (da-DK) and Niamh (en-IE) +* feature: SecurityHub: Added new resource detail objects to ASFF, including resources for AwsGuardDutyDetector, AwsAmazonMqBroker, AwsEventSchemasRegistry, AwsAppSyncGraphQlApi and AwsStepFunctionStateMachine. +* feature: SecurityLake: Log sources are now versioned. AWS log sources and custom sources will now come with a version identifier that enables producers to vend multiple schema versions to subscribers. Security Lake API have been refactored to more closely align with AWS API conventions. +* feature: WAFV2: This SDK release provides customers the ability to use Header Order as a field to match. + ## 2.1386.0 * feature: Connect: Documentation update for a new Initiation Method value in DescribeContact API * feature: IoTWireless: Add Multicast Group support in Network Analyzer Configuration. diff --git a/README.md b/README.md index 62eacdc3a3..cd244fdd53 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ require('aws-sdk/lib/maintenance_mode_message').suppress = true; To use the SDK in the browser, simply add the following script tag to your HTML pages: - + You can also build a custom browser SDK with your specified set of AWS services. This can allow you to reduce the SDK's size, specify different API versions of diff --git a/SERVICES.md b/SERVICES.md index 6f21198d82..641d4788bf 100644 --- a/SERVICES.md +++ b/SERVICES.md @@ -198,3 +198,4 @@ Amazon DocumentDB with MongoDB compatibility | AWS.DocDB | 2014-10-31 | | AWS Backup | AWS.Backup | 2018-11-15 | | Amazon WorkLink | AWS.WorkLink | 2018-09-25 | | Amazon Textract | AWS.Textract | 2018-06-27 | | +Amazon Managed Service for Prometheus | AWS.Amp | 2020-08-01 | :tada: | diff --git a/apis/alexaforbusiness-2017-11-09.min.json b/apis/alexaforbusiness-2017-11-09.min.json index 16f2a2d042..cd35661e09 100644 --- a/apis/alexaforbusiness-2017-11-09.min.json +++ b/apis/alexaforbusiness-2017-11-09.min.json @@ -25,7 +25,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateContactWithAddressBook": { "input": { @@ -42,7 +44,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateDeviceWithNetworkProfile": { "input": { @@ -59,7 +63,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateDeviceWithRoom": { "input": { @@ -72,7 +78,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateSkillGroupWithRoom": { "input": { @@ -85,7 +93,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateSkillWithSkillGroup": { "input": { @@ -101,7 +111,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateSkillWithUsers": { "input": { @@ -116,7 +128,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateAddressBook": { "input": { @@ -140,7 +154,9 @@ "members": { "AddressBookArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateBusinessReportSchedule": { "input": { @@ -173,7 +189,9 @@ "members": { "ScheduleArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateConferenceProvider": { "input": { @@ -208,7 +226,9 @@ "members": { "ConferenceProviderArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateContact": { "input": { @@ -242,7 +262,9 @@ "members": { "ContactArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateGatewayGroup": { "input": { @@ -267,7 +289,9 @@ "members": { "GatewayGroupArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateNetworkProfile": { "input": { @@ -307,7 +331,9 @@ "members": { "NetworkProfileArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateProfile": { "input": { @@ -395,6 +421,17 @@ "type": "boolean" } } + }, + "ProactiveJoin": { + "type": "structure", + "required": [ + "EnabledByMotion" + ], + "members": { + "EnabledByMotion": { + "type": "boolean" + } + } } } }, @@ -408,7 +445,9 @@ "members": { "ProfileArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateRoom": { "input": { @@ -434,7 +473,9 @@ "members": { "RoomArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateSkillGroup": { "input": { @@ -458,7 +499,9 @@ "members": { "SkillGroupArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateUser": { "input": { @@ -484,7 +527,9 @@ "members": { "UserArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteAddressBook": { "input": { @@ -499,7 +544,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteBusinessReportSchedule": { "input": { @@ -514,7 +561,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteConferenceProvider": { "input": { @@ -529,7 +578,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteContact": { "input": { @@ -544,7 +595,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteDevice": { "input": { @@ -559,7 +612,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteDeviceUsageData": { "input": { @@ -576,7 +631,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteGatewayGroup": { "input": { @@ -591,7 +648,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteNetworkProfile": { "input": { @@ -606,7 +665,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteProfile": { "input": { @@ -618,7 +679,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteRoom": { "input": { @@ -630,7 +693,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteRoomSkillParameter": { "input": { @@ -648,7 +713,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteSkillAuthorization": { "input": { @@ -664,7 +731,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteSkillGroup": { "input": { @@ -676,7 +745,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteUser": { "input": { @@ -692,7 +763,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateContactFromAddressBook": { "input": { @@ -709,7 +782,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateDeviceFromRoom": { "input": { @@ -721,7 +796,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateSkillFromSkillGroup": { "input": { @@ -737,7 +814,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateSkillFromUsers": { "input": { @@ -752,7 +831,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateSkillGroupFromRoom": { "input": { @@ -765,7 +846,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ForgetSmartHomeAppliances": { "input": { @@ -780,7 +863,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetAddressBook": { "input": { @@ -804,7 +889,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetConferencePreference": { "input": { @@ -815,10 +902,12 @@ "type": "structure", "members": { "Preference": { - "shape": "S4d" + "shape": "S4e" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetConferenceProvider": { "input": { @@ -834,10 +923,12 @@ "type": "structure", "members": { "ConferenceProvider": { - "shape": "S4g" + "shape": "S4h" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetContact": { "input": { @@ -871,7 +962,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetDevice": { "input": { @@ -895,7 +988,7 @@ "RoomArn": {}, "DeviceStatus": {}, "DeviceStatusInfo": { - "shape": "S4t" + "shape": "S4u" }, "NetworkProfileInfo": { "type": "structure", @@ -910,7 +1003,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetGateway": { "input": { @@ -936,7 +1031,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetGatewayGroup": { "input": { @@ -960,7 +1057,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetInvitationConfiguration": { "input": { @@ -973,10 +1072,12 @@ "OrganizationName": {}, "ContactEmail": {}, "PrivateSkillIds": { - "shape": "S5e" + "shape": "S5f" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetNetworkProfile": { "input": { @@ -1013,7 +1114,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetProfile": { "input": { @@ -1091,13 +1194,23 @@ "type": "boolean" } } + }, + "ProactiveJoin": { + "type": "structure", + "members": { + "EnabledByMotion": { + "type": "boolean" + } + } } } } } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetRoom": { "input": { @@ -1120,7 +1233,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetRoomSkillParameter": { "input": { @@ -1139,10 +1254,12 @@ "type": "structure", "members": { "RoomSkillParameter": { - "shape": "S5u" + "shape": "S5w" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetSkillGroup": { "input": { @@ -1163,7 +1280,9 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListBusinessReportSchedules": { "input": { @@ -1217,7 +1336,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListConferenceProviders": { "input": { @@ -1235,12 +1356,14 @@ "ConferenceProviders": { "type": "list", "member": { - "shape": "S4g" + "shape": "S4h" } }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListDeviceEvents": { "input": { @@ -1275,7 +1398,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListGatewayGroups": { "input": { @@ -1303,7 +1428,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListGateways": { "input": { @@ -1334,7 +1461,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSkills": { "input": { @@ -1369,7 +1498,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSkillsStoreCategories": { "input": { @@ -1398,7 +1529,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSkillsStoreSkillsByCategory": { "input": { @@ -1479,7 +1612,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSmartHomeAppliances": { "input": { @@ -1511,7 +1646,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListTags": { "input": { @@ -1535,7 +1672,9 @@ }, "NextToken": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutConferencePreference": { "input": { @@ -1545,14 +1684,16 @@ ], "members": { "ConferencePreference": { - "shape": "S4d" + "shape": "S4e" } } }, "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutInvitationConfiguration": { "input": { @@ -1564,14 +1705,16 @@ "OrganizationName": {}, "ContactEmail": {}, "PrivateSkillIds": { - "shape": "S5e" + "shape": "S5f" } } }, "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutRoomSkillParameter": { "input": { @@ -1584,14 +1727,16 @@ "RoomArn": {}, "SkillId": {}, "RoomSkillParameter": { - "shape": "S5u" + "shape": "S5w" } } }, "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutSkillAuthorization": { "input": { @@ -1614,7 +1759,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "RegisterAVSDevice": { "input": { @@ -1642,7 +1789,9 @@ "members": { "DeviceArn": {} } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "RejectSkill": { "input": { @@ -1657,7 +1806,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ResolveRoom": { "input": { @@ -1679,11 +1830,13 @@ "RoomSkillParameters": { "type": "list", "member": { - "shape": "S5u" + "shape": "S5w" } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "RevokeInvitation": { "input": { @@ -1696,17 +1849,19 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchAddressBooks": { "input": { "type": "structure", "members": { "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" }, "NextToken": {}, "MaxResults": { @@ -1733,17 +1888,19 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchContacts": { "input": { "type": "structure", "members": { "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" }, "NextToken": {}, "MaxResults": { @@ -1780,7 +1937,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchDevices": { "input": { @@ -1791,10 +1950,10 @@ "type": "integer" }, "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" } } }, @@ -1818,7 +1977,7 @@ "RoomArn": {}, "RoomName": {}, "DeviceStatusInfo": { - "shape": "S4t" + "shape": "S4u" }, "CreatedTime": { "type": "timestamp" @@ -1831,7 +1990,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchNetworkProfiles": { "input": { @@ -1842,10 +2003,10 @@ "type": "integer" }, "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" } } }, @@ -1872,7 +2033,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchProfiles": { "input": { @@ -1883,10 +2046,10 @@ "type": "integer" }, "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" } } }, @@ -1917,7 +2080,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchRooms": { "input": { @@ -1928,10 +2093,10 @@ "type": "integer" }, "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" } } }, @@ -1957,7 +2122,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchSkillGroups": { "input": { @@ -1968,10 +2135,10 @@ "type": "integer" }, "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" } } }, @@ -1994,7 +2161,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchUsers": { "input": { @@ -2005,10 +2174,10 @@ "type": "integer" }, "Filters": { - "shape": "S92" + "shape": "S94" }, "SortCriteria": { - "shape": "S97" + "shape": "S99" } } }, @@ -2034,7 +2203,9 @@ "type": "integer" } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SendAnnouncement": { "input": { @@ -2046,7 +2217,7 @@ ], "members": { "RoomFilters": { - "shape": "S92" + "shape": "S94" }, "Content": { "type": "structure", @@ -2120,7 +2291,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "StartDeviceSync": { "input": { @@ -2140,7 +2313,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "StartSmartHomeApplianceDiscovery": { "input": { @@ -2155,7 +2330,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "TagResource": { "input": { @@ -2174,7 +2351,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UntagResource": { "input": { @@ -2194,7 +2373,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateAddressBook": { "input": { @@ -2211,7 +2392,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateBusinessReportSchedule": { "input": { @@ -2233,7 +2416,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateConferenceProvider": { "input": { @@ -2260,7 +2445,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateContact": { "input": { @@ -2287,7 +2474,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateDevice": { "input": { @@ -2300,7 +2489,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateGateway": { "input": { @@ -2318,7 +2509,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateGatewayGroup": { "input": { @@ -2335,7 +2528,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateNetworkProfile": { "input": { @@ -2362,7 +2557,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateProfile": { "input": { @@ -2430,6 +2627,17 @@ "type": "boolean" } } + }, + "ProactiveJoin": { + "type": "structure", + "required": [ + "EnabledByMotion" + ], + "members": { + "EnabledByMotion": { + "type": "boolean" + } + } } } } @@ -2438,7 +2646,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateRoom": { "input": { @@ -2454,7 +2664,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateSkillGroup": { "input": { @@ -2468,7 +2680,9 @@ "output": { "type": "structure", "members": {} - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" } }, "shapes": { @@ -2597,13 +2811,13 @@ "type": "integer" } }, - "S4d": { + "S4e": { "type": "structure", "members": { "DefaultConferenceProviderArn": {} } }, - "S4g": { + "S4h": { "type": "structure", "members": { "Arn": {}, @@ -2620,7 +2834,7 @@ } } }, - "S4t": { + "S4u": { "type": "structure", "members": { "DeviceStatusDetails": { @@ -2639,11 +2853,11 @@ } } }, - "S5e": { + "S5f": { "type": "list", "member": {} }, - "S5u": { + "S5w": { "type": "structure", "required": [ "ParameterKey", @@ -2654,7 +2868,7 @@ "ParameterValue": {} } }, - "S92": { + "S94": { "type": "list", "member": { "type": "structure", @@ -2671,7 +2885,7 @@ } } }, - "S97": { + "S99": { "type": "list", "member": { "type": "structure", @@ -2685,5 +2899,7 @@ } } } - } + }, + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" } \ No newline at end of file diff --git a/apis/alexaforbusiness-2017-11-09.normal.json b/apis/alexaforbusiness-2017-11-09.normal.json index 9a2e75dbd9..01b24c384b 100644 --- a/apis/alexaforbusiness-2017-11-09.normal.json +++ b/apis/alexaforbusiness-2017-11-09.normal.json @@ -35,7 +35,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "
Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
" + "documentation": "Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateContactWithAddressBook": { "name": "AssociateContactWithAddressBook", @@ -54,7 +56,9 @@ "shape": "LimitExceededException" } ], - "documentation": "Associates a contact with a given address book.
" + "documentation": "Associates a contact with a given address book.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateDeviceWithNetworkProfile": { "name": "AssociateDeviceWithNetworkProfile", @@ -79,7 +83,9 @@ "shape": "DeviceNotRegisteredException" } ], - "documentation": "Associates a device with the specified network profile.
" + "documentation": "Associates a device with the specified network profile.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateDeviceWithRoom": { "name": "AssociateDeviceWithRoom", @@ -104,7 +110,9 @@ "shape": "DeviceNotRegisteredException" } ], - "documentation": "Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
" + "documentation": "Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateSkillGroupWithRoom": { "name": "AssociateSkillGroupWithRoom", @@ -123,7 +131,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
" + "documentation": "Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateSkillWithSkillGroup": { "name": "AssociateSkillWithSkillGroup", @@ -148,7 +158,9 @@ "shape": "SkillNotLinkedException" } ], - "documentation": "Associates a skill with a skill group.
" + "documentation": "Associates a skill with a skill group.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "AssociateSkillWithUsers": { "name": "AssociateSkillWithUsers", @@ -170,7 +182,9 @@ "shape": "NotFoundException" } ], - "documentation": "Makes a private skill available for enrolled users to enable on their devices.
" + "documentation": "Makes a private skill available for enrolled users to enable on their devices.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateAddressBook": { "name": "CreateAddressBook", @@ -192,7 +206,9 @@ "shape": "LimitExceededException" } ], - "documentation": "Creates an address book with the specified details.
" + "documentation": "Creates an address book with the specified details.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateBusinessReportSchedule": { "name": "CreateBusinessReportSchedule", @@ -211,7 +227,9 @@ "shape": "AlreadyExistsException" } ], - "documentation": "Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
" + "documentation": "Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateConferenceProvider": { "name": "CreateConferenceProvider", @@ -230,7 +248,9 @@ "shape": "AlreadyExistsException" } ], - "documentation": "Adds a new conference provider under the user's AWS account.
" + "documentation": "Adds a new conference provider under the user's AWS account.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateContact": { "name": "CreateContact", @@ -252,7 +272,9 @@ "shape": "LimitExceededException" } ], - "documentation": "Creates a contact with the specified details.
" + "documentation": "Creates a contact with the specified details.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateGatewayGroup": { "name": "CreateGatewayGroup", @@ -274,7 +296,9 @@ "shape": "LimitExceededException" } ], - "documentation": "Creates a gateway group with the specified details.
" + "documentation": "Creates a gateway group with the specified details.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateNetworkProfile": { "name": "CreateNetworkProfile", @@ -305,7 +329,9 @@ "shape": "InvalidServiceLinkedRoleStateException" } ], - "documentation": "Creates a network profile with the specified details.
" + "documentation": "Creates a network profile with the specified details.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateProfile": { "name": "CreateProfile", @@ -330,7 +356,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Creates a new room profile with the specified details.
" + "documentation": "Creates a new room profile with the specified details.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateRoom": { "name": "CreateRoom", @@ -352,7 +380,9 @@ "shape": "LimitExceededException" } ], - "documentation": "Creates a room with the specified details.
" + "documentation": "Creates a room with the specified details.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateSkillGroup": { "name": "CreateSkillGroup", @@ -377,7 +407,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Creates a skill group with a specified name and description.
" + "documentation": "Creates a skill group with a specified name and description.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "CreateUser": { "name": "CreateUser", @@ -402,7 +434,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Creates a user.
" + "documentation": "Creates a user.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteAddressBook": { "name": "DeleteAddressBook", @@ -424,7 +458,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes an address book by the address book ARN.
" + "documentation": "Deletes an address book by the address book ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteBusinessReportSchedule": { "name": "DeleteBusinessReportSchedule", @@ -446,7 +482,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes the recurring report delivery schedule with the specified schedule ARN.
" + "documentation": "Deletes the recurring report delivery schedule with the specified schedule ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteConferenceProvider": { "name": "DeleteConferenceProvider", @@ -465,7 +503,9 @@ "shape": "NotFoundException" } ], - "documentation": "Deletes a conference provider.
" + "documentation": "Deletes a conference provider.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteContact": { "name": "DeleteContact", @@ -487,7 +527,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes a contact by the contact ARN.
" + "documentation": "Deletes a contact by the contact ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteDevice": { "name": "DeleteDevice", @@ -512,7 +554,9 @@ "shape": "InvalidCertificateAuthorityException" } ], - "documentation": "Removes a device from Alexa For Business.
" + "documentation": "Removes a device from Alexa For Business.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteDeviceUsageData": { "name": "DeleteDeviceUsageData", @@ -537,7 +581,9 @@ "shape": "LimitExceededException" } ], - "documentation": "When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
" + "documentation": "When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteGatewayGroup": { "name": "DeleteGatewayGroup", @@ -556,7 +602,9 @@ "shape": "ResourceAssociatedException" } ], - "documentation": "Deletes a gateway group.
" + "documentation": "Deletes a gateway group.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteNetworkProfile": { "name": "DeleteNetworkProfile", @@ -581,7 +629,9 @@ "shape": "NotFoundException" } ], - "documentation": "Deletes a network profile by the network profile ARN.
" + "documentation": "Deletes a network profile by the network profile ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteProfile": { "name": "DeleteProfile", @@ -603,7 +653,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes a room profile by the profile ARN.
" + "documentation": "Deletes a room profile by the profile ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteRoom": { "name": "DeleteRoom", @@ -625,7 +677,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes a room by the room ARN.
" + "documentation": "Deletes a room by the room ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteRoomSkillParameter": { "name": "DeleteRoomSkillParameter", @@ -644,7 +698,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes room skill parameter details by room, skill, and parameter key ID.
" + "documentation": "Deletes room skill parameter details by room, skill, and parameter key ID.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteSkillAuthorization": { "name": "DeleteSkillAuthorization", @@ -666,7 +722,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Unlinks a third-party account from a skill.
" + "documentation": "Unlinks a third-party account from a skill.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteSkillGroup": { "name": "DeleteSkillGroup", @@ -688,7 +746,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes a skill group by skill group ARN.
" + "documentation": "Deletes a skill group by skill group ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DeleteUser": { "name": "DeleteUser", @@ -710,7 +770,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Deletes a specified user by user ARN and enrollment ARN.
" + "documentation": "Deletes a specified user by user ARN and enrollment ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateContactFromAddressBook": { "name": "DisassociateContactFromAddressBook", @@ -724,7 +786,9 @@ "output": { "shape": "DisassociateContactFromAddressBookResponse" }, - "documentation": "Disassociates a contact from a given address book.
" + "documentation": "Disassociates a contact from a given address book.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateDeviceFromRoom": { "name": "DisassociateDeviceFromRoom", @@ -746,7 +810,9 @@ "shape": "DeviceNotRegisteredException" } ], - "documentation": "Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
" + "documentation": "Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateSkillFromSkillGroup": { "name": "DisassociateSkillFromSkillGroup", @@ -768,7 +834,9 @@ "shape": "NotFoundException" } ], - "documentation": "Disassociates a skill from a skill group.
" + "documentation": "Disassociates a skill from a skill group.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateSkillFromUsers": { "name": "DisassociateSkillFromUsers", @@ -790,7 +858,9 @@ "shape": "NotFoundException" } ], - "documentation": "Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
" + "documentation": "Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "DisassociateSkillGroupFromRoom": { "name": "DisassociateSkillGroupFromRoom", @@ -809,7 +879,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
" + "documentation": "Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ForgetSmartHomeAppliances": { "name": "ForgetSmartHomeAppliances", @@ -828,7 +900,9 @@ "shape": "NotFoundException" } ], - "documentation": "Forgets smart home appliances associated to a room.
" + "documentation": "Forgets smart home appliances associated to a room.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetAddressBook": { "name": "GetAddressBook", @@ -847,7 +921,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets address the book details by the address book ARN.
" + "documentation": "Gets address the book details by the address book ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetConferencePreference": { "name": "GetConferencePreference", @@ -866,7 +942,9 @@ "shape": "NotFoundException" } ], - "documentation": "Retrieves the existing conference preferences.
" + "documentation": "Retrieves the existing conference preferences.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetConferenceProvider": { "name": "GetConferenceProvider", @@ -885,7 +963,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets details about a specific conference provider.
" + "documentation": "Gets details about a specific conference provider.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetContact": { "name": "GetContact", @@ -904,7 +984,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets the contact details by the contact ARN.
" + "documentation": "Gets the contact details by the contact ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetDevice": { "name": "GetDevice", @@ -923,7 +1005,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets the details of a device by device ARN.
" + "documentation": "Gets the details of a device by device ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetGateway": { "name": "GetGateway", @@ -942,7 +1026,9 @@ "shape": "NotFoundException" } ], - "documentation": "Retrieves the details of a gateway.
" + "documentation": "Retrieves the details of a gateway.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetGatewayGroup": { "name": "GetGatewayGroup", @@ -961,7 +1047,9 @@ "shape": "NotFoundException" } ], - "documentation": "Retrieves the details of a gateway group.
" + "documentation": "Retrieves the details of a gateway group.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetInvitationConfiguration": { "name": "GetInvitationConfiguration", @@ -980,7 +1068,9 @@ "shape": "NotFoundException" } ], - "documentation": "Retrieves the configured values for the user enrollment invitation email template.
" + "documentation": "Retrieves the configured values for the user enrollment invitation email template.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetNetworkProfile": { "name": "GetNetworkProfile", @@ -1002,7 +1092,9 @@ "shape": "InvalidSecretsManagerResourceException" } ], - "documentation": "Gets the network profile details by the network profile ARN.
" + "documentation": "Gets the network profile details by the network profile ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetProfile": { "name": "GetProfile", @@ -1021,7 +1113,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets the details of a room profile by profile ARN.
" + "documentation": "Gets the details of a room profile by profile ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetRoom": { "name": "GetRoom", @@ -1040,7 +1134,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets room details by room ARN.
" + "documentation": "Gets room details by room ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetRoomSkillParameter": { "name": "GetRoomSkillParameter", @@ -1059,7 +1155,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets room skill parameter details by room, skill, and parameter key ARN.
" + "documentation": "Gets room skill parameter details by room, skill, and parameter key ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "GetSkillGroup": { "name": "GetSkillGroup", @@ -1078,7 +1176,9 @@ "shape": "NotFoundException" } ], - "documentation": "Gets skill group details by skill group ARN.
" + "documentation": "Gets skill group details by skill group ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListBusinessReportSchedules": { "name": "ListBusinessReportSchedules", @@ -1092,7 +1192,9 @@ "output": { "shape": "ListBusinessReportSchedulesResponse" }, - "documentation": "Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
" + "documentation": "Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListConferenceProviders": { "name": "ListConferenceProviders", @@ -1106,7 +1208,9 @@ "output": { "shape": "ListConferenceProvidersResponse" }, - "documentation": "Lists conference providers under a specific AWS account.
" + "documentation": "Lists conference providers under a specific AWS account.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListDeviceEvents": { "name": "ListDeviceEvents", @@ -1125,7 +1229,9 @@ "shape": "NotFoundException" } ], - "documentation": "Lists the device event history, including device connection status, for up to 30 days.
" + "documentation": "Lists the device event history, including device connection status, for up to 30 days.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListGatewayGroups": { "name": "ListGatewayGroups", @@ -1139,7 +1245,9 @@ "output": { "shape": "ListGatewayGroupsResponse" }, - "documentation": "Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
" + "documentation": "Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListGateways": { "name": "ListGateways", @@ -1153,7 +1261,9 @@ "output": { "shape": "ListGatewaysResponse" }, - "documentation": "Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
" + "documentation": "Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSkills": { "name": "ListSkills", @@ -1167,7 +1277,9 @@ "output": { "shape": "ListSkillsResponse" }, - "documentation": "Lists all enabled skills in a specific skill group.
" + "documentation": "Lists all enabled skills in a specific skill group.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSkillsStoreCategories": { "name": "ListSkillsStoreCategories", @@ -1181,7 +1293,9 @@ "output": { "shape": "ListSkillsStoreCategoriesResponse" }, - "documentation": "Lists all categories in the Alexa skill store.
" + "documentation": "Lists all categories in the Alexa skill store.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSkillsStoreSkillsByCategory": { "name": "ListSkillsStoreSkillsByCategory", @@ -1195,7 +1309,9 @@ "output": { "shape": "ListSkillsStoreSkillsByCategoryResponse" }, - "documentation": "Lists all skills in the Alexa skill store by category.
" + "documentation": "Lists all skills in the Alexa skill store by category.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListSmartHomeAppliances": { "name": "ListSmartHomeAppliances", @@ -1214,7 +1330,9 @@ "shape": "NotFoundException" } ], - "documentation": "Lists all of the smart home appliances associated with a room.
" + "documentation": "Lists all of the smart home appliances associated with a room.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ListTags": { "name": "ListTags", @@ -1233,7 +1351,9 @@ "shape": "NotFoundException" } ], - "documentation": "Lists all tags for the specified resource.
" + "documentation": "Lists all tags for the specified resource.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutConferencePreference": { "name": "PutConferencePreference", @@ -1252,7 +1372,9 @@ "shape": "NotFoundException" } ], - "documentation": "Sets the conference preferences on a specific conference provider at the account level.
" + "documentation": "Sets the conference preferences on a specific conference provider at the account level.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutInvitationConfiguration": { "name": "PutInvitationConfiguration", @@ -1274,7 +1396,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Configures the email template for the user enrollment invitation with the specified attributes.
" + "documentation": "Configures the email template for the user enrollment invitation with the specified attributes.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutRoomSkillParameter": { "name": "PutRoomSkillParameter", @@ -1293,7 +1417,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
" + "documentation": "Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "PutSkillAuthorization": { "name": "PutSkillAuthorization", @@ -1315,7 +1441,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
" + "documentation": "Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "RegisterAVSDevice": { "name": "RegisterAVSDevice", @@ -1343,7 +1471,9 @@ "shape": "InvalidDeviceException" } ], - "documentation": "Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
" + "documentation": "Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "RejectSkill": { "name": "RejectSkill", @@ -1365,7 +1495,9 @@ "shape": "NotFoundException" } ], - "documentation": "Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
" + "documentation": "Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "ResolveRoom": { "name": "ResolveRoom", @@ -1384,7 +1516,9 @@ "shape": "NotFoundException" } ], - "documentation": "Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.
" + "documentation": "Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "RevokeInvitation": { "name": "RevokeInvitation", @@ -1406,7 +1540,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Revokes an invitation and invalidates the enrollment URL.
" + "documentation": "Revokes an invitation and invalidates the enrollment URL.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchAddressBooks": { "name": "SearchAddressBooks", @@ -1420,7 +1556,9 @@ "output": { "shape": "SearchAddressBooksResponse" }, - "documentation": "Searches address books and lists the ones that meet a set of filter and sort criteria.
" + "documentation": "Searches address books and lists the ones that meet a set of filter and sort criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchContacts": { "name": "SearchContacts", @@ -1434,7 +1572,9 @@ "output": { "shape": "SearchContactsResponse" }, - "documentation": "Searches contacts and lists the ones that meet a set of filter and sort criteria.
" + "documentation": "Searches contacts and lists the ones that meet a set of filter and sort criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchDevices": { "name": "SearchDevices", @@ -1448,7 +1588,9 @@ "output": { "shape": "SearchDevicesResponse" }, - "documentation": "Searches devices and lists the ones that meet a set of filter criteria.
" + "documentation": "Searches devices and lists the ones that meet a set of filter criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchNetworkProfiles": { "name": "SearchNetworkProfiles", @@ -1462,7 +1604,9 @@ "output": { "shape": "SearchNetworkProfilesResponse" }, - "documentation": "Searches network profiles and lists the ones that meet a set of filter and sort criteria.
" + "documentation": "Searches network profiles and lists the ones that meet a set of filter and sort criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchProfiles": { "name": "SearchProfiles", @@ -1476,7 +1620,9 @@ "output": { "shape": "SearchProfilesResponse" }, - "documentation": "Searches room profiles and lists the ones that meet a set of filter criteria.
" + "documentation": "Searches room profiles and lists the ones that meet a set of filter criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchRooms": { "name": "SearchRooms", @@ -1490,7 +1636,9 @@ "output": { "shape": "SearchRoomsResponse" }, - "documentation": "Searches rooms and lists the ones that meet a set of filter and sort criteria.
" + "documentation": "Searches rooms and lists the ones that meet a set of filter and sort criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchSkillGroups": { "name": "SearchSkillGroups", @@ -1504,7 +1652,9 @@ "output": { "shape": "SearchSkillGroupsResponse" }, - "documentation": "Searches skill groups and lists the ones that meet a set of filter and sort criteria.
" + "documentation": "Searches skill groups and lists the ones that meet a set of filter and sort criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SearchUsers": { "name": "SearchUsers", @@ -1518,7 +1668,9 @@ "output": { "shape": "SearchUsersResponse" }, - "documentation": "Searches users and lists the ones that meet a set of filter and sort criteria.
" + "documentation": "Searches users and lists the ones that meet a set of filter and sort criteria.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "SendAnnouncement": { "name": "SendAnnouncement", @@ -1565,7 +1717,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
" + "documentation": "Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "StartDeviceSync": { "name": "StartDeviceSync", @@ -1584,7 +1738,9 @@ "shape": "DeviceNotRegisteredException" } ], - "documentation": "Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:
Bluetooth - This unpairs all bluetooth devices paired with your echo device.
Volume - This resets the echo device's volume to the default value.
Notifications - This clears all notifications from your echo device.
Lists - This clears all to-do items from your echo device.
Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:
Bluetooth - This unpairs all bluetooth devices paired with your echo device.
Volume - This resets the echo device's volume to the default value.
Notifications - This clears all notifications from your echo device.
Lists - This clears all to-do items from your echo device.
Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
Initiates the discovery of any smart home appliances associated with the room.
" + "documentation": "Initiates the discovery of any smart home appliances associated with the room.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "TagResource": { "name": "TagResource", @@ -1622,7 +1780,9 @@ "shape": "NotFoundException" } ], - "documentation": "Adds metadata tags to a specified resource.
" + "documentation": "Adds metadata tags to a specified resource.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UntagResource": { "name": "UntagResource", @@ -1641,7 +1801,9 @@ "shape": "NotFoundException" } ], - "documentation": "Removes metadata tags from a specified resource.
" + "documentation": "Removes metadata tags from a specified resource.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateAddressBook": { "name": "UpdateAddressBook", @@ -1666,7 +1828,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Updates address book details by the address book ARN.
" + "documentation": "Updates address book details by the address book ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateBusinessReportSchedule": { "name": "UpdateBusinessReportSchedule", @@ -1688,7 +1852,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Updates the configuration of the report delivery schedule with the specified schedule ARN.
" + "documentation": "Updates the configuration of the report delivery schedule with the specified schedule ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateConferenceProvider": { "name": "UpdateConferenceProvider", @@ -1707,7 +1873,9 @@ "shape": "NotFoundException" } ], - "documentation": "Updates an existing conference provider's settings.
" + "documentation": "Updates an existing conference provider's settings.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateContact": { "name": "UpdateContact", @@ -1729,7 +1897,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Updates the contact details by the contact ARN.
" + "documentation": "Updates the contact details by the contact ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateDevice": { "name": "UpdateDevice", @@ -1754,7 +1924,9 @@ "shape": "DeviceNotRegisteredException" } ], - "documentation": "Updates the device name by device ARN.
" + "documentation": "Updates the device name by device ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateGateway": { "name": "UpdateGateway", @@ -1776,7 +1948,9 @@ "shape": "NameInUseException" } ], - "documentation": "Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
" + "documentation": "Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateGatewayGroup": { "name": "UpdateGatewayGroup", @@ -1798,7 +1972,9 @@ "shape": "NameInUseException" } ], - "documentation": "Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
" + "documentation": "Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateNetworkProfile": { "name": "UpdateNetworkProfile", @@ -1829,7 +2005,9 @@ "shape": "InvalidSecretsManagerResourceException" } ], - "documentation": "Updates a network profile by the network profile ARN.
" + "documentation": "Updates a network profile by the network profile ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateProfile": { "name": "UpdateProfile", @@ -1854,7 +2032,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Updates an existing room profile by room profile ARN.
" + "documentation": "Updates an existing room profile by room profile ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateRoom": { "name": "UpdateRoom", @@ -1876,7 +2056,9 @@ "shape": "NameInUseException" } ], - "documentation": "Updates room details by room ARN.
" + "documentation": "Updates room details by room ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" }, "UpdateSkillGroup": { "name": "UpdateSkillGroup", @@ -1901,7 +2083,9 @@ "shape": "ConcurrentModificationException" } ], - "documentation": "Updates skill group details by skill group ARN.
" + "documentation": "Updates skill group details by skill group ARN.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" } }, "shapes": { @@ -2819,6 +3003,9 @@ "RequireCheckIn": { "shape": "CreateRequireCheckIn", "documentation": "Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
" + }, + "ProactiveJoin": { + "shape": "CreateProactiveJoin" } }, "documentation": "Creates meeting room settings of a room profile.
" @@ -2887,6 +3074,17 @@ } } }, + "CreateProactiveJoin": { + "type": "structure", + "required": [ + "EnabledByMotion" + ], + "members": { + "EnabledByMotion": { + "shape": "Boolean" + } + } + }, "CreateProfileRequest": { "type": "structure", "required": [ @@ -3750,7 +3948,7 @@ "type": "string", "max": 128, "min": 1, - "pattern": "([0-9a-zA-Z]([+-.\\w]*[0-9a-zA-Z])*@([0-9a-zA-Z]([-\\w]*[0-9a-zA-Z]+)*\\.)+[a-zA-Z]{2,9})" + "pattern": "\\w[+-.\\w]*@\\w[\\w\\.\\-]+\\.[0-9a-zA-Z]{2,24}" }, "EnablementType": { "type": "string", @@ -4684,6 +4882,9 @@ "RequireCheckIn": { "shape": "RequireCheckIn", "documentation": "Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
" + }, + "ProactiveJoin": { + "shape": "ProactiveJoin" } }, "documentation": "Meeting room settings of a room profile.
" @@ -4928,6 +5129,14 @@ "PrivacyPolicy": { "type": "string" }, + "ProactiveJoin": { + "type": "structure", + "members": { + "EnabledByMotion": { + "shape": "Boolean" + } + } + }, "ProductDescription": { "type": "string" }, @@ -6585,6 +6794,9 @@ "RequireCheckIn": { "shape": "UpdateRequireCheckIn", "documentation": "Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
" + }, + "ProactiveJoin": { + "shape": "UpdateProactiveJoin" } }, "documentation": "Updates meeting room settings of a room profile.
" @@ -6629,6 +6841,17 @@ "type": "structure", "members": {} }, + "UpdateProactiveJoin": { + "type": "structure", + "required": [ + "EnabledByMotion" + ], + "members": { + "EnabledByMotion": { + "shape": "Boolean" + } + } + }, "UpdateProfileRequest": { "type": "structure", "members": { @@ -6844,5 +7067,7 @@ "pattern": "[a-zA-Z0-9@_+.-]*" } }, - "documentation": "Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.
" + "documentation": "Alexa for Business has been retired and is no longer supported.
", + "deprecated": true, + "deprecatedMessage": "Alexa For Business is no longer supported" } \ No newline at end of file diff --git a/apis/appflow-2020-08-23.min.json b/apis/appflow-2020-08-23.min.json index 0e518105a1..5d673be2e8 100644 --- a/apis/appflow-2020-08-23.min.json +++ b/apis/appflow-2020-08-23.min.json @@ -94,16 +94,16 @@ "shape": "S3n" }, "destinationFlowConfigList": { - "shape": "S4g" + "shape": "S4j" }, "tasks": { - "shape": "S5g" + "shape": "S5j" }, "tags": { - "shape": "S66" + "shape": "S69" }, "metadataCatalogConfig": { - "shape": "S69" + "shape": "S6c" }, "clientToken": { "idempotencyToken": true @@ -178,7 +178,7 @@ "type": "structure", "members": { "connectorConfiguration": { - "shape": "S6n" + "shape": "S6q" } } } @@ -248,10 +248,10 @@ "valueRegexPattern": {}, "supportedDateFormat": {}, "fieldValueRange": { - "shape": "S8u" + "shape": "S90" }, "fieldLengthRange": { - "shape": "S8u" + "shape": "S90" } } } @@ -291,7 +291,7 @@ "type": "boolean" }, "supportedWriteOperations": { - "shape": "S8d" + "shape": "S8g" } } }, @@ -369,7 +369,7 @@ "type": "structure", "members": { "connectorTypes": { - "shape": "S6o" + "shape": "S6r" }, "maxResults": { "type": "integer" @@ -384,11 +384,11 @@ "type": "map", "key": {}, "value": { - "shape": "S6n" + "shape": "S6q" } }, "connectors": { - "shape": "S9c" + "shape": "S9i" }, "nextToken": {} } @@ -420,16 +420,16 @@ "shape": "S3n" }, "destinationFlowConfigList": { - "shape": "S4g" + "shape": "S4j" }, "lastRunExecutionDetails": { - "shape": "S9i" + "shape": "S9o" }, "triggerConfig": { "shape": "S3d" }, "tasks": { - "shape": "S5g" + "shape": "S5j" }, "createdAt": { "type": "timestamp" @@ -440,13 +440,13 @@ "createdBy": {}, "lastUpdatedBy": {}, "tags": { - "shape": "S66" + "shape": "S69" }, "metadataCatalogConfig": { - "shape": "S69" + "shape": "S6c" }, "lastRunMetadataCatalogDetails": { - "shape": "S9n" + "shape": "S9t" }, "schemaVersion": { "type": "long" @@ -517,7 +517,7 @@ "type": "timestamp" }, "metadataCatalogDetails": { - "shape": "S9n" + "shape": "S9t" } } } @@ -590,7 +590,7 @@ "type": "structure", "members": { "connectors": { - "shape": "S9c" + "shape": "S9i" }, "nextToken": {} } @@ -635,10 +635,10 @@ "createdBy": {}, "lastUpdatedBy": {}, "tags": { - "shape": "S66" + "shape": "S69" }, "lastRunExecutionDetails": { - "shape": "S9i" + "shape": "S9o" } } } @@ -668,7 +668,7 @@ "type": "structure", "members": { "tags": { - "shape": "S66" + "shape": "S69" } } } @@ -684,7 +684,7 @@ "description": {}, "connectorProvisioningType": {}, "connectorProvisioningConfig": { - "shape": "S8f" + "shape": "S8i" }, "clientToken": { "idempotencyToken": true @@ -760,7 +760,7 @@ "locationName": "resourceArn" }, "tags": { - "shape": "S66" + "shape": "S69" } } }, @@ -861,7 +861,7 @@ "connectorLabel": {}, "description": {}, "connectorProvisioningConfig": { - "shape": "S8f" + "shape": "S8i" }, "clientToken": { "idempotencyToken": true @@ -898,13 +898,13 @@ "shape": "S3n" }, "destinationFlowConfigList": { - "shape": "S4g" + "shape": "S4j" }, "tasks": { - "shape": "S5g" + "shape": "S5j" }, "metadataCatalogConfig": { - "shape": "S69" + "shape": "S6c" }, "clientToken": { "idempotencyToken": true @@ -1762,6 +1762,9 @@ "entityName": {}, "customProperties": { "shape": "S4c" + }, + "dataTransferApi": { + "shape": "S4d" } } }, @@ -1789,7 +1792,14 @@ "key": {}, "value": {} }, - "S4g": { + "S4d": { + "type": "structure", + "members": { + "Name": {}, + "Type": {} + } + }, + "S4j": { "type": "list", "member": { "type": "structure", @@ -1815,7 +1825,7 @@ "intermediateBucketName": {}, "bucketPrefix": {}, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" } } }, @@ -1832,10 +1842,10 @@ "members": { "fileType": {}, "prefixConfig": { - "shape": "S4o" + "shape": "S4r" }, "aggregationConfig": { - "shape": "S4t" + "shape": "S4w" }, "preserveSourceDataTyping": { "type": "boolean" @@ -1852,10 +1862,10 @@ "members": { "object": {}, "idFieldNames": { - "shape": "S4y" + "shape": "S51" }, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" }, "writeOperationType": {}, "dataTransferApi": {} @@ -1872,7 +1882,7 @@ "intermediateBucketName": {}, "bucketPrefix": {}, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" } } }, @@ -1884,7 +1894,7 @@ "members": { "object": {}, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" } } }, @@ -1909,10 +1919,10 @@ "members": { "fileType": {}, "prefixConfig": { - "shape": "S4o" + "shape": "S4r" }, "aggregationConfig": { - "shape": "S4t" + "shape": "S4w" } } } @@ -1926,7 +1936,7 @@ "members": { "object": {}, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" } } }, @@ -1948,10 +1958,10 @@ "members": { "object": {}, "idFieldNames": { - "shape": "S4y" + "shape": "S51" }, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" }, "writeOperationType": {} } @@ -1964,7 +1974,7 @@ "members": { "object": {}, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" } } }, @@ -1976,11 +1986,11 @@ "members": { "entityName": {}, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" }, "writeOperationType": {}, "idFieldNames": { - "shape": "S4y" + "shape": "S51" }, "customProperties": { "shape": "S4c" @@ -2002,10 +2012,10 @@ } }, "idFieldNames": { - "shape": "S4y" + "shape": "S51" }, "errorHandlingConfig": { - "shape": "S4k" + "shape": "S4n" }, "writeOperationType": {} } @@ -2015,7 +2025,7 @@ } } }, - "S4k": { + "S4n": { "type": "structure", "members": { "failOnFirstDestinationError": { @@ -2025,7 +2035,7 @@ "bucketName": {} } }, - "S4o": { + "S4r": { "type": "structure", "members": { "prefixType": {}, @@ -2036,7 +2046,7 @@ } } }, - "S4t": { + "S4w": { "type": "structure", "members": { "aggregationType": {}, @@ -2045,11 +2055,11 @@ } } }, - "S4y": { + "S51": { "type": "list", "member": {} }, - "S5g": { + "S5j": { "type": "list", "member": { "type": "structure", @@ -2094,12 +2104,12 @@ } } }, - "S66": { + "S69": { "type": "map", "key": {}, "value": {} }, - "S69": { + "S6c": { "type": "structure", "members": { "glueDataCatalog": { @@ -2117,7 +2127,7 @@ } } }, - "S6n": { + "S6q": { "type": "structure", "members": { "canUseAsSource": { @@ -2127,7 +2137,7 @@ "type": "boolean" }, "supportedDestinationConnectors": { - "shape": "S6o" + "shape": "S6r" }, "supportedSchedulingFrequencies": { "type": "list", @@ -2193,7 +2203,7 @@ "member": {} }, "oauth2GrantTypesSupported": { - "shape": "S73" + "shape": "S76" } } }, @@ -2276,7 +2286,7 @@ "connectorVersion": {}, "connectorArn": {}, "connectorModes": { - "shape": "S7n" + "shape": "S7q" }, "authenticationConfig": { "type": "structure", @@ -2308,7 +2318,7 @@ "member": {} }, "oauth2GrantTypesSupported": { - "shape": "S73" + "shape": "S76" }, "oauth2CustomProperties": { "type": "list", @@ -2325,7 +2335,7 @@ "type": "boolean" }, "connectorSuppliedValues": { - "shape": "S7x" + "shape": "S80" }, "type": {} } @@ -2354,7 +2364,7 @@ "type": "boolean" }, "connectorSuppliedValues": { - "shape": "S7x" + "shape": "S80" } } } @@ -2393,40 +2403,49 @@ "member": {} }, "supportedWriteOperations": { - "shape": "S8d" + "shape": "S8g" }, "connectorProvisioningType": {}, "connectorProvisioningConfig": { - "shape": "S8f" + "shape": "S8i" }, "logoURL": {}, "registeredAt": { "type": "timestamp" }, - "registeredBy": {} + "registeredBy": {}, + "supportedDataTransferTypes": { + "shape": "S8m" + }, + "supportedDataTransferApis": { + "type": "list", + "member": { + "shape": "S4d" + } + } } }, - "S6o": { + "S6r": { "type": "list", "member": {} }, - "S73": { + "S76": { "type": "list", "member": {} }, - "S7n": { + "S7q": { "type": "list", "member": {} }, - "S7x": { + "S80": { "type": "list", "member": {} }, - "S8d": { + "S8g": { "type": "list", "member": {} }, - "S8f": { + "S8i": { "type": "structure", "members": { "lambda": { @@ -2440,7 +2459,11 @@ } } }, - "S8u": { + "S8m": { + "type": "list", + "member": {} + }, + "S90": { "type": "structure", "members": { "maximum": { @@ -2451,7 +2474,7 @@ } } }, - "S9c": { + "S9i": { "type": "list", "member": { "type": "structure", @@ -2469,12 +2492,15 @@ "registeredBy": {}, "connectorProvisioningType": {}, "connectorModes": { - "shape": "S7n" + "shape": "S7q" + }, + "supportedDataTransferTypes": { + "shape": "S8m" } } } }, - "S9i": { + "S9o": { "type": "structure", "members": { "mostRecentExecutionMessage": {}, @@ -2484,7 +2510,7 @@ "mostRecentExecutionStatus": {} } }, - "S9n": { + "S9t": { "type": "list", "member": { "type": "structure", @@ -2492,15 +2518,15 @@ "catalogType": {}, "tableName": {}, "tableRegistrationOutput": { - "shape": "S9q" + "shape": "S9w" }, "partitionRegistrationOutput": { - "shape": "S9q" + "shape": "S9w" } } } }, - "S9q": { + "S9w": { "type": "structure", "members": { "message": {}, diff --git a/apis/appflow-2020-08-23.normal.json b/apis/appflow-2020-08-23.normal.json index fe46458c5b..7236c54fae 100644 --- a/apis/appflow-2020-08-23.normal.json +++ b/apis/appflow-2020-08-23.normal.json @@ -1151,6 +1151,14 @@ "registeredBy": { "shape": "RegisteredBy", "documentation": "Information about who registered the connector.
" + }, + "supportedDataTransferTypes": { + "shape": "SupportedDataTransferTypeList", + "documentation": "The data transfer types that the connector supports.
Structured records.
Files or binary data.
The APIs of the connector application that Amazon AppFlow can use to transfer your data.
" } }, "documentation": "The configuration settings related to a given connector.
" @@ -1215,6 +1223,10 @@ "connectorModes": { "shape": "ConnectorModeList", "documentation": "The connection mode that the connector supports.
" + }, + "supportedDataTransferTypes": { + "shape": "SupportedDataTransferTypeList", + "documentation": "The data transfer types that the connector supports.
Structured records.
Files or binary data.
Information about the registered connector.
" @@ -2171,6 +2183,10 @@ "customProperties": { "shape": "CustomProperties", "documentation": "Custom properties that are required to use the custom connector as a source.
" + }, + "dataTransferApi": { + "shape": "DataTransferApi", + "documentation": "The API of the connector application that Amazon AppFlow uses to transfer your data.
" } }, "documentation": "The properties that are applied when the custom connector is being used as a source.
" @@ -2231,6 +2247,33 @@ "Complete" ] }, + "DataTransferApi": { + "type": "structure", + "members": { + "Name": { + "shape": "DataTransferApiTypeName", + "documentation": "The name of the connector application API.
" + }, + "Type": { + "shape": "DataTransferApiType", + "documentation": "You can specify one of the following types:
The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.
A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
An asynchronous API. This type of API optimizes a flow for large datasets.
The API of the connector application that Amazon AppFlow uses to transfer your data.
" + }, + "DataTransferApiType": { + "type": "string", + "enum": [ + "SYNC", + "ASYNC", + "AUTOMATIC" + ] + }, + "DataTransferApiTypeName": { + "type": "string", + "max": 64, + "pattern": "[\\w/-]+" + }, "DatabaseName": { "type": "string", "max": 512, @@ -5433,6 +5476,25 @@ "shape": "SupportedApiVersion" } }, + "SupportedDataTransferApis": { + "type": "list", + "member": { + "shape": "DataTransferApi" + } + }, + "SupportedDataTransferType": { + "type": "string", + "enum": [ + "RECORD", + "FILE" + ] + }, + "SupportedDataTransferTypeList": { + "type": "list", + "member": { + "shape": "SupportedDataTransferType" + } + }, "SupportedFieldTypeDetails": { "type": "structure", "required": [ diff --git a/apis/athena-2017-05-18.min.json b/apis/athena-2017-05-18.min.json index 5406fcbf33..d87fa3a5da 100644 --- a/apis/athena-2017-05-18.min.json +++ b/apis/athena-2017-05-18.min.json @@ -298,6 +298,22 @@ "members": {} } }, + "DeleteCapacityReservation": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, "DeleteDataCatalog": { "input": { "type": "structure", @@ -396,7 +412,7 @@ "type": "structure", "members": { "NotebookMetadata": { - "shape": "S32" + "shape": "S34" }, "Payload": {} } @@ -420,10 +436,10 @@ "Description": {}, "WorkingDirectory": {}, "Status": { - "shape": "S39" + "shape": "S3b" }, "Statistics": { - "shape": "S3b" + "shape": "S3d" }, "Result": { "type": "structure", @@ -468,10 +484,10 @@ "type": "structure", "members": { "Status": { - "shape": "S39" + "shape": "S3b" }, "Statistics": { - "shape": "S3b" + "shape": "S3d" } } } @@ -497,7 +513,7 @@ "members": { "CapacityReservationName": {}, "CapacityAssignments": { - "shape": "S3m" + "shape": "S3o" } } } @@ -521,7 +537,7 @@ ], "members": { "CapacityReservation": { - "shape": "S3r" + "shape": "S3t" } } } @@ -573,7 +589,7 @@ "type": "structure", "members": { "Database": { - "shape": "S42" + "shape": "S44" } } } @@ -611,7 +627,7 @@ "type": "structure", "members": { "NotebookMetadata": { - "shape": "S32" + "shape": "S34" } } } @@ -789,7 +805,7 @@ } }, "OutputStage": { - "shape": "S4v" + "shape": "S4x" } } } @@ -814,7 +830,7 @@ "WorkGroup": {}, "EngineVersion": {}, "EngineConfiguration": { - "shape": "S52" + "shape": "S54" }, "NotebookVersion": {}, "SessionConfiguration": { @@ -831,7 +847,7 @@ } }, "Status": { - "shape": "S57" + "shape": "S59" }, "Statistics": { "type": "structure", @@ -859,7 +875,7 @@ "members": { "SessionId": {}, "Status": { - "shape": "S57" + "shape": "S59" } } } @@ -882,7 +898,7 @@ "type": "structure", "members": { "TableMetadata": { - "shape": "S5e" + "shape": "S5g" } } } @@ -1003,7 +1019,7 @@ "CalculationExecutionId": {}, "Description": {}, "Status": { - "shape": "S39" + "shape": "S3b" } } } @@ -1031,7 +1047,7 @@ "CapacityReservations": { "type": "list", "member": { - "shape": "S3r" + "shape": "S3t" } } } @@ -1084,7 +1100,7 @@ "DatabaseList": { "type": "list", "member": { - "shape": "S42" + "shape": "S44" } }, "NextToken": {} @@ -1211,7 +1227,7 @@ "NotebookMetadataList": { "type": "list", "member": { - "shape": "S32" + "shape": "S34" } } } @@ -1338,7 +1354,7 @@ }, "NotebookVersion": {}, "Status": { - "shape": "S57" + "shape": "S59" } } } @@ -1369,7 +1385,7 @@ "TableMetadataList": { "type": "list", "member": { - "shape": "S5e" + "shape": "S5g" } }, "NextToken": {} @@ -1444,7 +1460,7 @@ "members": { "CapacityReservationName": {}, "CapacityAssignments": { - "shape": "S3m" + "shape": "S3o" } } }, @@ -1528,7 +1544,7 @@ "Description": {}, "WorkGroup": {}, "EngineConfiguration": { - "shape": "S52" + "shape": "S54" }, "NotebookVersion": {}, "SessionIdleTimeoutInMinutes": { @@ -2082,7 +2098,7 @@ "KmsKey": {} } }, - "S32": { + "S34": { "type": "structure", "members": { "NotebookId": {}, @@ -2097,7 +2113,7 @@ } } }, - "S39": { + "S3b": { "type": "structure", "members": { "SubmissionDateTime": { @@ -2110,7 +2126,7 @@ "StateChangeReason": {} } }, - "S3b": { + "S3d": { "type": "structure", "members": { "DpuExecutionInMillis": { @@ -2119,7 +2135,7 @@ "Progress": {} } }, - "S3m": { + "S3o": { "type": "list", "member": { "type": "structure", @@ -2131,7 +2147,7 @@ } } }, - "S3r": { + "S3t": { "type": "structure", "required": [ "Name", @@ -2174,7 +2190,7 @@ } } }, - "S42": { + "S44": { "type": "structure", "required": [ "Name" @@ -2187,7 +2203,7 @@ } } }, - "S4v": { + "S4x": { "type": "structure", "members": { "StageId": { @@ -2210,17 +2226,17 @@ "type": "long" }, "QueryStagePlan": { - "shape": "S4w" + "shape": "S4y" }, "SubStages": { "type": "list", "member": { - "shape": "S4v" + "shape": "S4x" } } } }, - "S4w": { + "S4y": { "type": "structure", "members": { "Name": {}, @@ -2228,7 +2244,7 @@ "Children": { "type": "list", "member": { - "shape": "S4w" + "shape": "S4y" } }, "RemoteSources": { @@ -2237,7 +2253,7 @@ } } }, - "S52": { + "S54": { "type": "structure", "required": [ "MaxConcurrentDpus" @@ -2257,7 +2273,7 @@ } } }, - "S57": { + "S59": { "type": "structure", "members": { "StartDateTime": { @@ -2276,7 +2292,7 @@ "StateChangeReason": {} } }, - "S5e": { + "S5g": { "type": "structure", "required": [ "Name" @@ -2291,17 +2307,17 @@ }, "TableType": {}, "Columns": { - "shape": "S5g" + "shape": "S5i" }, "PartitionKeys": { - "shape": "S5g" + "shape": "S5i" }, "Parameters": { "shape": "S1z" } } }, - "S5g": { + "S5i": { "type": "list", "member": { "type": "structure", diff --git a/apis/athena-2017-05-18.normal.json b/apis/athena-2017-05-18.normal.json index aa5b7b7446..2bd61fa626 100644 --- a/apis/athena-2017-05-18.normal.json +++ b/apis/athena-2017-05-18.normal.json @@ -98,7 +98,7 @@ "shape": "InternalServerException" } ], - "documentation": "Cancels the capacity reservation with the specified name.
", + "documentation": "Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.
", "idempotent": true }, "CreateCapacityReservation": { @@ -263,6 +263,29 @@ ], "documentation": "Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
" }, + "DeleteCapacityReservation": { + "name": "DeleteCapacityReservation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteCapacityReservationInput" + }, + "output": { + "shape": "DeleteCapacityReservationOutput" + }, + "errors": [ + { + "shape": "InvalidRequestException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation
, and deleted reservations do not appear in the output of ListCapacityReservations
.
The name of the capacity reservation to delete.
" + } + } + }, + "DeleteCapacityReservationOutput": { + "type": "structure", + "members": {} + }, "DeleteDataCatalogInput": { "type": "structure", "required": [ @@ -4241,7 +4280,7 @@ }, "ExecutionParameters": { "shape": "ExecutionParameters", - "documentation": "A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
" + "documentation": "A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.
" }, "SubstatementType": { "shape": "String", diff --git a/apis/chime-sdk-voice-2022-08-03.min.json b/apis/chime-sdk-voice-2022-08-03.min.json index 6d2e2903a1..04a09de987 100644 --- a/apis/chime-sdk-voice-2022-08-03.min.json +++ b/apis/chime-sdk-voice-2022-08-03.min.json @@ -2241,7 +2241,8 @@ }, "TransactionId": {}, "VoiceProfileDomainId": {}, - "ClientRequestToken": {} + "ClientRequestToken": {}, + "CallLeg": {} } }, "output": { diff --git a/apis/chime-sdk-voice-2022-08-03.normal.json b/apis/chime-sdk-voice-2022-08-03.normal.json index 2f3ca36211..f3a61a5c2a 100644 --- a/apis/chime-sdk-voice-2022-08-03.normal.json +++ b/apis/chime-sdk-voice-2022-08-03.normal.json @@ -3820,6 +3820,13 @@ }, "documentation": "The details of an Amazon Chime SDK Voice Connector call.
" }, + "CallLegType": { + "type": "string", + "enum": [ + "Caller", + "Callee" + ] + }, "CallingName": { "type": "string", "pattern": "^$|^[a-zA-Z0-9 ]{2,15}$", @@ -6823,6 +6830,10 @@ "ClientRequestToken": { "shape": "ClientRequestId", "documentation": "The unique identifier for the client request. Use a different token for different speaker search tasks.
" + }, + "CallLeg": { + "shape": "CallLegType", + "documentation": "Specifies which call leg to stream for speaker search.
" } } }, diff --git a/apis/cloudformation-2010-05-15.min.json b/apis/cloudformation-2010-05-15.min.json index f28a0a2ce5..718bbc6216 100644 --- a/apis/cloudformation-2010-05-15.min.json +++ b/apis/cloudformation-2010-05-15.min.json @@ -11,6 +11,17 @@ "xmlNamespace": "http://cloudformation.amazonaws.com/doc/2010-05-15/" }, "operations": { + "ActivateOrganizationsAccess": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "ActivateOrganizationsAccessResult", + "type": "structure", + "members": {} + } + }, "ActivateType": { "input": { "type": "structure", @@ -24,7 +35,7 @@ "type": "boolean" }, "LoggingConfig": { - "shape": "S7" + "shape": "S9" }, "ExecutionRoleArn": {}, "VersionBump": {}, @@ -52,7 +63,7 @@ "TypeConfigurationIdentifiers": { "type": "list", "member": { - "shape": "Sg" + "shape": "Si" } } } @@ -69,7 +80,7 @@ "ErrorCode": {}, "ErrorMessage": {}, "TypeConfigurationIdentifier": { - "shape": "Sg" + "shape": "Si" } } } @@ -77,7 +88,7 @@ "UnprocessedTypeConfigurations": { "type": "list", "member": { - "shape": "Sg" + "shape": "Si" } }, "TypeConfigurations": { @@ -151,23 +162,23 @@ "type": "boolean" }, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "ResourceTypes": { - "shape": "S1f" + "shape": "S1h" }, "RoleARN": {}, "RollbackConfiguration": { - "shape": "S1h" + "shape": "S1j" }, "NotificationARNs": { - "shape": "S1n" + "shape": "S1p" }, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "ChangeSetName": {}, "ClientToken": {}, @@ -218,32 +229,32 @@ "TemplateBody": {}, "TemplateURL": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "DisableRollback": { "type": "boolean" }, "RollbackConfiguration": { - "shape": "S1h" + "shape": "S1j" }, "TimeoutInMinutes": { "type": "integer" }, "NotificationARNs": { - "shape": "S1n" + "shape": "S1p" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "ResourceTypes": { - "shape": "S1f" + "shape": "S1h" }, "RoleARN": {}, "OnFailure": {}, "StackPolicyBody": {}, "StackPolicyURL": {}, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "ClientRequestToken": {}, "EnableTerminationProtection": { @@ -269,19 +280,19 @@ "members": { "StackSetName": {}, "Accounts": { - "shape": "S2h" + "shape": "S2j" }, "DeploymentTargets": { - "shape": "S2j" + "shape": "S2l" }, "Regions": { - "shape": "S2o" + "shape": "S2q" }, "ParameterOverrides": { - "shape": "S18" + "shape": "S1a" }, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "OperationId": { "idempotencyToken": true @@ -310,26 +321,26 @@ "TemplateURL": {}, "StackId": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "AdministrationRoleARN": {}, "ExecutionRoleName": {}, "PermissionModel": {}, "AutoDeployment": { - "shape": "S31" + "shape": "S33" }, "CallAs": {}, "ClientRequestToken": { "idempotencyToken": true }, "ManagedExecution": { - "shape": "S34" + "shape": "S36" } } }, @@ -341,6 +352,17 @@ } } }, + "DeactivateOrganizationsAccess": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "DeactivateOrganizationsAccessResult", + "type": "structure", + "members": {} + } + }, "DeactivateType": { "input": { "type": "structure", @@ -402,16 +424,16 @@ "members": { "StackSetName": {}, "Accounts": { - "shape": "S2h" + "shape": "S2j" }, "DeploymentTargets": { - "shape": "S2j" + "shape": "S2l" }, "Regions": { - "shape": "S2o" + "shape": "S2q" }, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "RetainStacks": { "type": "boolean" @@ -513,7 +535,7 @@ "StackName": {}, "Description": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "CreationTime": { "type": "timestamp" @@ -522,16 +544,16 @@ "Status": {}, "StatusReason": {}, "NotificationARNs": { - "shape": "S1n" + "shape": "S1p" }, "RollbackConfiguration": { - "shape": "S1h" + "shape": "S1j" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "Changes": { "type": "list", @@ -575,7 +597,7 @@ }, "ChangeSetId": {}, "ModuleInfo": { - "shape": "S4j" + "shape": "S4n" } } } @@ -644,6 +666,21 @@ } } }, + "DescribeOrganizationsAccess": { + "input": { + "type": "structure", + "members": { + "CallAs": {} + } + }, + "output": { + "resultWrapper": "DescribeOrganizationsAccessResult", + "type": "structure", + "members": { + "Status": {} + } + } + }, "DescribePublisher": { "input": { "type": "structure", @@ -772,11 +809,11 @@ "Account": {}, "StackId": {}, "ParameterOverrides": { - "shape": "S18" + "shape": "S1a" }, "Status": {}, "StackInstanceStatus": { - "shape": "S5r" + "shape": "S5y" }, "StatusReason": {}, "OrganizationalUnitId": {}, @@ -828,10 +865,10 @@ "Description": {}, "Metadata": {}, "DriftInformation": { - "shape": "S5y" + "shape": "S65" }, "ModuleInfo": { - "shape": "S4j" + "shape": "S4n" } } } @@ -866,7 +903,7 @@ "StackResourceDrifts": { "type": "list", "member": { - "shape": "S65" + "shape": "S6c" } }, "NextToken": {} @@ -909,10 +946,10 @@ "ResourceStatusReason": {}, "Description": {}, "DriftInformation": { - "shape": "S5y" + "shape": "S65" }, "ModuleInfo": { - "shape": "S4j" + "shape": "S4n" } } } @@ -944,32 +981,32 @@ "Status": {}, "TemplateBody": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "StackSetARN": {}, "AdministrationRoleARN": {}, "ExecutionRoleName": {}, "StackSetDriftDetectionDetails": { - "shape": "S6p" + "shape": "S6w" }, "AutoDeployment": { - "shape": "S31" + "shape": "S33" }, "PermissionModel": {}, "OrganizationalUnitIds": { - "shape": "S2l" + "shape": "S2n" }, "ManagedExecution": { - "shape": "S34" + "shape": "S36" }, "Regions": { - "shape": "S2o" + "shape": "S2q" } } } @@ -1001,7 +1038,7 @@ "Action": {}, "Status": {}, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "RetainStacks": { "type": "boolean" @@ -1015,14 +1052,14 @@ "type": "timestamp" }, "DeploymentTargets": { - "shape": "S2j" + "shape": "S2l" }, "StackSetDriftDetectionDetails": { - "shape": "S6p" + "shape": "S6w" }, "StatusReason": {}, "StatusDetails": { - "shape": "S74" + "shape": "S7b" } } } @@ -1056,7 +1093,7 @@ "ChangeSetId": {}, "Description": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "CreationTime": { "type": "timestamp" @@ -1068,7 +1105,7 @@ "type": "timestamp" }, "RollbackConfiguration": { - "shape": "S1h" + "shape": "S1j" }, "StackStatus": {}, "StackStatusReason": {}, @@ -1076,13 +1113,13 @@ "type": "boolean" }, "NotificationARNs": { - "shape": "S1n" + "shape": "S1p" }, "TimeoutInMinutes": { "type": "integer" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "Outputs": { "type": "list", @@ -1098,7 +1135,7 @@ }, "RoleARN": {}, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "EnableTerminationProtection": { "type": "boolean" @@ -1154,7 +1191,7 @@ "ProvisioningType": {}, "DeprecatedStatus": {}, "LoggingConfig": { - "shape": "S7" + "shape": "S9" }, "RequiredActivatedTypes": { "type": "list", @@ -1230,7 +1267,7 @@ "members": { "StackName": {}, "LogicalResourceIds": { - "shape": "S85" + "shape": "S8c" } } }, @@ -1265,7 +1302,7 @@ ], "members": { "StackResourceDrift": { - "shape": "S65" + "shape": "S6c" } } } @@ -1279,7 +1316,7 @@ "members": { "StackSetName": {}, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "OperationId": { "idempotencyToken": true @@ -1302,7 +1339,7 @@ "TemplateBody": {}, "TemplateURL": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" } } }, @@ -1415,16 +1452,16 @@ }, "Description": {}, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "CapabilitiesReason": {}, "ResourceTypes": { - "shape": "S1f" + "shape": "S1h" }, "Version": {}, "Metadata": {}, "DeclaredTransforms": { - "shape": "S8y" + "shape": "S95" }, "ResourceIdentifierSummaries": { "type": "list", @@ -1433,7 +1470,7 @@ "members": { "ResourceType": {}, "LogicalResourceIds": { - "shape": "S85" + "shape": "S8c" }, "ResourceIdentifiers": { "type": "list", @@ -1459,10 +1496,10 @@ }, "StackIdsUrl": {}, "OrganizationalUnitIds": { - "shape": "S2l" + "shape": "S2n" }, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "OperationId": { "idempotencyToken": true @@ -1613,7 +1650,7 @@ "Status": {}, "StatusReason": {}, "StackInstanceStatus": { - "shape": "S5r" + "shape": "S5y" }, "OrganizationalUnitId": {}, "DriftStatus": {}, @@ -1675,7 +1712,7 @@ } }, "ModuleInfo": { - "shape": "S4j" + "shape": "S4n" } } } @@ -1774,10 +1811,10 @@ }, "StatusReason": {}, "StatusDetails": { - "shape": "S74" + "shape": "S7b" }, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" } } } @@ -1812,7 +1849,7 @@ "Description": {}, "Status": {}, "AutoDeployment": { - "shape": "S31" + "shape": "S33" }, "PermissionModel": {}, "DriftStatus": {}, @@ -1820,7 +1857,7 @@ "type": "timestamp" }, "ManagedExecution": { - "shape": "S34" + "shape": "S36" } } } @@ -2090,7 +2127,7 @@ "TypeName": {}, "SchemaHandlerPackage": {}, "LoggingConfig": { - "shape": "S7" + "shape": "S9" }, "ExecutionRoleArn": {}, "ClientRequestToken": {} @@ -2249,25 +2286,25 @@ "StackPolicyDuringUpdateBody": {}, "StackPolicyDuringUpdateURL": {}, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "ResourceTypes": { - "shape": "S1f" + "shape": "S1h" }, "RoleARN": {}, "RollbackConfiguration": { - "shape": "S1h" + "shape": "S1j" }, "StackPolicyBody": {}, "StackPolicyURL": {}, "NotificationARNs": { - "shape": "S1n" + "shape": "S1p" }, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "DisableRollback": { "type": "boolean" @@ -2293,19 +2330,19 @@ "members": { "StackSetName": {}, "Accounts": { - "shape": "S2h" + "shape": "S2j" }, "DeploymentTargets": { - "shape": "S2j" + "shape": "S2l" }, "Regions": { - "shape": "S2o" + "shape": "S2q" }, "ParameterOverrides": { - "shape": "S18" + "shape": "S1a" }, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "OperationId": { "idempotencyToken": true @@ -2336,38 +2373,38 @@ "type": "boolean" }, "Parameters": { - "shape": "S18" + "shape": "S1a" }, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "Tags": { - "shape": "S1p" + "shape": "S1r" }, "OperationPreferences": { - "shape": "S2q" + "shape": "S2s" }, "AdministrationRoleARN": {}, "ExecutionRoleName": {}, "DeploymentTargets": { - "shape": "S2j" + "shape": "S2l" }, "PermissionModel": {}, "AutoDeployment": { - "shape": "S31" + "shape": "S33" }, "OperationId": { "idempotencyToken": true }, "Accounts": { - "shape": "S2h" + "shape": "S2j" }, "Regions": { - "shape": "S2o" + "shape": "S2q" }, "CallAs": {}, "ManagedExecution": { - "shape": "S34" + "shape": "S36" } } }, @@ -2429,18 +2466,18 @@ }, "Description": {}, "Capabilities": { - "shape": "S1d" + "shape": "S1f" }, "CapabilitiesReason": {}, "DeclaredTransforms": { - "shape": "S8y" + "shape": "S95" } } } } }, "shapes": { - "S7": { + "S9": { "type": "structure", "required": [ "LogRoleArn", @@ -2451,7 +2488,7 @@ "LogGroupName": {} } }, - "Sg": { + "Si": { "type": "structure", "members": { "TypeArn": {}, @@ -2461,7 +2498,7 @@ "TypeName": {} } }, - "S18": { + "S1a": { "type": "list", "member": { "type": "structure", @@ -2475,15 +2512,15 @@ } } }, - "S1d": { + "S1f": { "type": "list", "member": {} }, - "S1f": { + "S1h": { "type": "list", "member": {} }, - "S1h": { + "S1j": { "type": "structure", "members": { "RollbackTriggers": { @@ -2505,11 +2542,11 @@ } } }, - "S1n": { + "S1p": { "type": "list", "member": {} }, - "S1p": { + "S1r": { "type": "list", "member": { "type": "structure", @@ -2523,37 +2560,37 @@ } } }, - "S2h": { + "S2j": { "type": "list", "member": {} }, - "S2j": { + "S2l": { "type": "structure", "members": { "Accounts": { - "shape": "S2h" + "shape": "S2j" }, "AccountsUrl": {}, "OrganizationalUnitIds": { - "shape": "S2l" + "shape": "S2n" }, "AccountFilterType": {} } }, - "S2l": { + "S2n": { "type": "list", "member": {} }, - "S2o": { + "S2q": { "type": "list", "member": {} }, - "S2q": { + "S2s": { "type": "structure", "members": { "RegionConcurrencyType": {}, "RegionOrder": { - "shape": "S2o" + "shape": "S2q" }, "FailureToleranceCount": { "type": "integer" @@ -2569,7 +2606,7 @@ } } }, - "S31": { + "S33": { "type": "structure", "members": { "Enabled": { @@ -2580,7 +2617,7 @@ } } }, - "S34": { + "S36": { "type": "structure", "members": { "Active": { @@ -2588,20 +2625,20 @@ } } }, - "S4j": { + "S4n": { "type": "structure", "members": { "TypeHierarchy": {}, "LogicalIdHierarchy": {} } }, - "S5r": { + "S5y": { "type": "structure", "members": { "DetailedStatus": {} } }, - "S5y": { + "S65": { "type": "structure", "required": [ "StackResourceDriftStatus" @@ -2613,7 +2650,7 @@ } } }, - "S65": { + "S6c": { "type": "structure", "required": [ "StackId", @@ -2666,11 +2703,11 @@ "type": "timestamp" }, "ModuleInfo": { - "shape": "S4j" + "shape": "S4n" } } }, - "S6p": { + "S6w": { "type": "structure", "members": { "DriftStatus": {}, @@ -2695,7 +2732,7 @@ } } }, - "S74": { + "S7b": { "type": "structure", "members": { "FailedStackInstancesCount": { @@ -2703,11 +2740,11 @@ } } }, - "S85": { + "S8c": { "type": "list", "member": {} }, - "S8y": { + "S95": { "type": "list", "member": {} } diff --git a/apis/cloudformation-2010-05-15.normal.json b/apis/cloudformation-2010-05-15.normal.json index 1470c1d6e0..955a85de86 100644 --- a/apis/cloudformation-2010-05-15.normal.json +++ b/apis/cloudformation-2010-05-15.normal.json @@ -11,6 +11,29 @@ "xmlNamespace": "http://cloudformation.amazonaws.com/doc/2010-05-15/" }, "operations": { + "ActivateOrganizationsAccess": { + "name": "ActivateOrganizationsAccess", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ActivateOrganizationsAccessInput" + }, + "output": { + "shape": "ActivateOrganizationsAccessOutput", + "resultWrapper": "ActivateOrganizationsAccessResult" + }, + "errors": [ + { + "shape": "InvalidOperationException" + }, + { + "shape": "OperationNotFoundException" + } + ], + "documentation": "Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
" + }, "ActivateType": { "name": "ActivateType", "http": { @@ -32,7 +55,7 @@ "shape": "TypeNotFoundException" } ], - "documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", "idempotent": true }, "BatchDescribeTypeConfigurations": { @@ -56,7 +79,7 @@ "shape": "CFNRegistryException" } ], - "documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" }, "CancelUpdateStack": { "name": "CancelUpdateStack", @@ -210,6 +233,29 @@ ], "documentation": "Creates a stack set.
" }, + "DeactivateOrganizationsAccess": { + "name": "DeactivateOrganizationsAccess", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeactivateOrganizationsAccessInput" + }, + "output": { + "shape": "DeactivateOrganizationsAccessOutput", + "resultWrapper": "DeactivateOrganizationsAccessResult" + }, + "errors": [ + { + "shape": "InvalidOperationException" + }, + { + "shape": "OperationNotFoundException" + } + ], + "documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
" + }, "DeactivateType": { "name": "DeactivateType", "http": { @@ -231,7 +277,7 @@ "shape": "TypeNotFoundException" } ], - "documentation": "Deactivates a public extension that was previously activated in this account and region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
", + "documentation": "Deactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
", "idempotent": true }, "DeleteChangeSet": { @@ -404,6 +450,29 @@ ], "documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
" }, + "DescribeOrganizationsAccess": { + "name": "DescribeOrganizationsAccess", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeOrganizationsAccessInput" + }, + "output": { + "shape": "DescribeOrganizationsAccessOutput", + "resultWrapper": "DescribeOrganizationsAccessResult" + }, + "errors": [ + { + "shape": "InvalidOperationException" + }, + { + "shape": "OperationNotFoundException" + } + ], + "documentation": "Retrieves information about the account's OrganizationAccess
status. This API can be called either by the management account or the delegated administrator by using the CallAs
parameter. This API can also be called without the CallAs
parameter by the management account.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift
returns a StackDriftDetectionId
you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus
. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift
returns a StackDriftDetectionId
you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus
. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
" + "documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" }, "DescribeStackResource": { "name": "DescribeStackResource", @@ -541,7 +610,7 @@ "shape": "StackSetNotFoundException" } ], - "documentation": "Returns the description of the specified stack set.
" + "documentation": "Returns the description of the specified StackSet.
" }, "DescribeStackSetOperation": { "name": "DescribeStackSetOperation", @@ -564,7 +633,7 @@ "shape": "OperationNotFoundException" } ], - "documentation": "Returns the description of the specified stack set operation.
" + "documentation": "Returns the description of the specified StackSet operation.
" }, "DescribeStacks": { "name": "DescribeStacks", @@ -639,7 +708,7 @@ "shape": "DetectStackDriftOutput", "resultWrapper": "DetectStackDriftResult" }, - "documentation": "Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift
to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
DetectStackDrift
can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift
directly on the nested stack itself.
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift
to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
DetectStackDrift
can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift
directly on the nested stack itself.
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackResourceDrift
to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
" + "documentation": "Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackResourceDrift
to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
" }, "DetectStackSetDrift": { "name": "DetectStackSetDrift", @@ -817,7 +886,7 @@ "shape": "StaleRequestException" } ], - "documentation": "Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
ImportStacksToStackSet
is only supported by self-managed permissions.
Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
" }, "ListChangeSets": { "name": "ListChangeSets", @@ -1056,7 +1125,7 @@ "shape": "TypeNotFoundException" } ], - "documentation": "Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", + "documentation": "Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", "idempotent": true }, "RecordHandlerProgress": { @@ -1122,7 +1191,7 @@ "shape": "CFNRegistryException" } ], - "documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType
, you can use DescribeTypeRegistration
to monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType
, you can use DescribeTypeRegistration
to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", "idempotent": true }, "RollbackStack": { @@ -1177,7 +1246,7 @@ "shape": "TypeNotFoundException" } ], - "documentation": "Specifies the configuration data for a registered CloudFormation extension, in the given account and region.
To view the current configuration data for an extension, refer to the ConfigurationSchema
element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema
element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType
, you can pass the returned TypeVersionArn
into DescribeType to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED
before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType
, you can pass the returned TypeVersionArn
into DescribeType to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED
before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.
An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.
" + "documentation": "An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.
An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.
" }, "AutoUpdate": { "shape": "AutoUpdate", - "documentation": "Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
The default is true
.
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
The default is true
.
Contains logging configuration information for an extension.
" }, "ExecutionRoleArn": { "shape": "RoleArn", @@ -1511,7 +1589,7 @@ "members": { "Arn": { "shape": "PrivateTypeArn", - "documentation": "The Amazon Resource Name (ARN) of the activated extension, in this account and region.
" + "documentation": "The Amazon Resource Name (ARN) of the activated extension, in this account and Region.
" } } }, @@ -1559,7 +1637,8 @@ "documentation": "The error message.
" }, "TypeConfigurationIdentifier": { - "shape": "TypeConfigurationIdentifier" + "shape": "TypeConfigurationIdentifier", + "documentation": "Identifying information for the configuration of a CloudFormation extension.
" } }, "documentation": "Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
" @@ -1624,7 +1703,7 @@ "members": { "StackName": { "shape": "StackName", - "documentation": "The name or the unique stack ID that's associated with the stack.
" + "documentation": "If you don't pass a parameter to StackName
, the API returns a response that describes all resources in the account.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:
{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
The name or the unique stack ID that's associated with the stack.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", @@ -2253,12 +2332,20 @@ "CreationTime": { "type": "timestamp" }, + "DeactivateOrganizationsAccessInput": { + "type": "structure", + "members": {} + }, + "DeactivateOrganizationsAccessOutput": { + "type": "structure", + "members": {} + }, "DeactivateTypeInput": { "type": "structure", "members": { "TypeName": { "shape": "TypeName", - "documentation": "The type name of the extension, in this account and region. If you specified a type name alias when enabling the extension, use the type name alias.
Conditional: You must specify either Arn
, or TypeName
and Type
.
The type name of the extension, in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.
Conditional: You must specify either Arn
, or TypeName
and Type
.
The Amazon Resource Name (ARN) for the extension, in this account and region.
Conditional: You must specify either Arn
, or TypeName
and Type
.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
Conditional: You must specify either Arn
, or TypeName
and Type
.
The output for the DescribeChangeSet action.
" }, + "DescribeOrganizationsAccessInput": { + "type": "structure", + "members": { + "CallAs": { + "shape": "CallAs", + "documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF
is specified.
If you are signed in to the management account, specify SELF
.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN
.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Presents the status of the OrganizationAccess
.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
" + "documentation": "If you don't pass a parameter to StackName
, the API returns a response that describes all resources in the account. This requires ListStacks
and DescribeStacks
permissions.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:
{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
" }, "NextToken": { "shape": "NextToken", @@ -3067,7 +3172,7 @@ }, "ConfigurationSchema": { "shape": "ConfigurationSchema", - "documentation": "A JSON string that represent the current configuration data for the extension in this account and region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" }, "PublisherId": { "shape": "PublisherId", @@ -3075,11 +3180,11 @@ }, "OriginalTypeName": { "shape": "TypeName", - "documentation": "For public extensions that have been activated for this account and region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.
" + "documentation": "For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.
" }, "PublicVersionNumber": { "shape": "PublicVersionNumber", @@ -3091,11 +3196,11 @@ }, "IsActivated": { "shape": "IsActivated", - "documentation": "Whether the extension is activated in the account and region.
This only applies to public third-party extensions. For all other extensions, CloudFormation returns null
.
Whether the extension is activated in the account and Region.
This only applies to public third-party extensions. For all other extensions, CloudFormation returns null
.
Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.
" + "documentation": "Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.
" } } }, @@ -3205,7 +3310,8 @@ "documentation": "The name of the stack set on which to perform the drift detection operation.
" }, "OperationPreferences": { - "shape": "StackSetOperationPreferences" + "shape": "StackSetOperationPreferences", + "documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" }, "OperationId": { "shape": "ClientRequestToken", @@ -3627,7 +3733,8 @@ "documentation": "The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
" }, "OperationPreferences": { - "shape": "StackSetOperationPreferences" + "shape": "StackSetOperationPreferences", + "documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" }, "OperationId": { "shape": "ClientRequestToken", @@ -4087,7 +4194,7 @@ "members": { "Visibility": { "shape": "Visibility", - "documentation": "The scope at which the extensions are visible and usable in CloudFormation operations.
Valid values include:
PRIVATE
: Extensions that are visible and usable within this account and region. This includes:
Private extensions you have registered in this account and region.
Public extensions that you have activated in this account and region.
PUBLIC
: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
The default is PRIVATE
.
The scope at which the extensions are visible and usable in CloudFormation operations.
Valid values include:
PRIVATE
: Extensions that are visible and usable within this account and Region. This includes:
Private extensions you have registered in this account and Region.
Public extensions that you have activated in this account and Region.
PUBLIC
: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
The default is PRIVATE
.
A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /
.
In the following example, the resource was created from a module, moduleA
, that's nested inside a parent module, moduleB
.
moduleA/moduleB
For more information, see Referencing resources in a module in the CloudFormation User Guide.
" + "documentation": "A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /
.
In the following example, the resource was created from a module, moduleA
, that's nested inside a parent module, moduleB
.
moduleA/moduleB
For more information, see Referencing resources in a module in the CloudFormation User Guide.
" } }, - "documentation": "Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
For more information about modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.
" + "documentation": "Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
For more information about modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.
" }, "MonitoringTimeInMinutes": { "type": "integer", @@ -4292,6 +4399,14 @@ "type": "string", "max": 4096 }, + "OrganizationStatus": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED", + "DISABLED_PERMANENTLY" + ] + }, "OrganizationalUnitId": { "type": "string", "pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$" @@ -4680,7 +4795,7 @@ }, "ExecutionRoleArn": { "shape": "RoleArn", - "documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com
). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
" + "documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com
). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
" }, "ClientRequestToken": { "shape": "RequestToken", @@ -4744,11 +4859,11 @@ "members": { "TypeNameAlias": { "shape": "TypeName", - "documentation": "An alias assigned to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.
" + "documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.
" }, "OriginalTypeName": { "shape": "TypeName", - "documentation": "The type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
The type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
" + "documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you activate the type in this account and Region. For private extensions, this will be the ARN assigned when you register the type in this account and Region.
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.
" }, "Configuration": { "shape": "TypeConfiguration", - "documentation": "The configuration data for the extension, in this account and region.
The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema
response element of API_DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema
response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
The Amazon Resource Name (ARN) for the configuration data, in this account and region.
Conditional: You must specify ConfigurationArn
, or Type
and TypeName
.
The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
Conditional: You must specify ConfigurationArn
, or Type
and TypeName
.
Information about whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation": "Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation": "The Stack data type.
" @@ -6058,7 +6173,8 @@ "documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
" }, "Regions": { - "shape": "RegionList" + "shape": "RegionList", + "documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
" } }, "documentation": "A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.
" @@ -6341,7 +6457,8 @@ "documentation": "Detailed information about the stack set operation.
" }, "OperationPreferences": { - "shape": "StackSetOperationPreferences" + "shape": "StackSetOperationPreferences", + "documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" } }, "documentation": "The structures that contain summary information about the specified operation.
" @@ -6494,7 +6611,7 @@ }, "DriftInformation": { "shape": "StackDriftInformationSummary", - "documentation": "Summarizes information about whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation": "Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation": "The StackSummary Data Type
" @@ -6650,7 +6767,7 @@ }, "VersionId": { "shape": "TypeVersionId", - "documentation": "The version of the extension to test.
You can specify the version id with either Arn
, or with TypeName
and Type
.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and region for testing.
" + "documentation": "The version of the extension to test.
You can specify the version id with either Arn
, or with TypeName
and Type
.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.
" }, "LogDeliveryBucket": { "shape": "S3Bucket", @@ -6730,7 +6847,7 @@ "members": { "Arn": { "shape": "TypeConfigurationArn", - "documentation": "The Amazon Resource Name (ARN) for the configuration data, in this account and region.
" + "documentation": "The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
" }, "Alias": { "shape": "TypeConfigurationAlias", @@ -6738,7 +6855,7 @@ }, "Configuration": { "shape": "TypeConfiguration", - "documentation": "A JSON string specifying the configuration data for the extension, in this account and region.
If a configuration hasn't been set for a specified extension, CloudFormation returns {}
.
A JSON string specifying the configuration data for the extension, in this account and Region.
If a configuration hasn't been set for a specified extension, CloudFormation returns {}
.
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
" + "documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you activate the type in this account and Region. For private extensions, this will be the ARN assigned when you register the type in this account and Region.
" }, "TypeName": { "shape": "TypeName", @@ -6757,7 +6874,7 @@ "documentation": "Whether this configuration data is the default configuration for the extension.
" } }, - "documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" }, "TypeConfigurationDetailsList": { "type": "list", @@ -6770,7 +6887,7 @@ "members": { "TypeArn": { "shape": "TypeArn", - "documentation": "The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
" + "documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
For public extensions, this will be the ARN assigned when you activate the type in this account and Region. For private extensions, this will be the ARN assigned when you register the type in this account and Region.
" }, "TypeConfigurationAlias": { "shape": "TypeConfigurationAlias", @@ -6778,7 +6895,7 @@ }, "TypeConfigurationArn": { "shape": "TypeConfigurationArn", - "documentation": "The Amazon Resource Name (ARN) for the configuration, in this account and region.
" + "documentation": "The Amazon Resource Name (ARN) for the configuration, in this account and Region.
" }, "Type": { "shape": "ThirdPartyType", @@ -6803,7 +6920,7 @@ "members": { "Category": { "shape": "Category", - "documentation": "The category of extensions to return.
REGISTERED
: Private extensions that have been registered for this account and region.
ACTIVATED
: Public extensions that have been activated for this account and region.
THIRD_PARTY
: Extensions available for use from publishers other than Amazon. This includes:
Private extensions registered in the account.
Public extensions from publishers other than Amazon, whether activated or not.
AWS_TYPES
: Extensions available for use from Amazon.
The category of extensions to return.
REGISTERED
: Private extensions that have been registered for this account and Region.
ACTIVATED
: Public extensions that have been activated for this account and Region.
THIRD_PARTY
: Extensions available for use from publishers other than Amazon. This includes:
Private extensions registered in the account.
Public extensions from publishers other than Amazon, whether activated or not.
AWS_TYPES
: Extensions available for use from Amazon.
The name of the extension.
If you specified a TypeNameAlias
when you activate this extension in your account and region, CloudFormation considers that alias as the type name.
The name of the extension.
If you specified a TypeNameAlias
when you activate this extension in your account and Region, CloudFormation considers that alias as the type name.
For public extensions that have been activated for this account and region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
Whether the extension is activated for this account and region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
" + "documentation": "Whether the extension is activated for this account and Region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
" } }, "documentation": "Contains summary information about the specified CloudFormation extension.
" @@ -6960,7 +7077,7 @@ }, "PublicVersionNumber": { "shape": "PublicVersionNumber", - "documentation": "For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region. For any extensions other than activated third-arty extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-arty extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
Contains summary information about a specific version of a CloudFormation extension.
" diff --git a/apis/cloudtrail-2013-11-01.min.json b/apis/cloudtrail-2013-11-01.min.json index 5c5a5718ff..828cf87230 100644 --- a/apis/cloudtrail-2013-11-01.min.json +++ b/apis/cloudtrail-2013-11-01.min.json @@ -120,7 +120,10 @@ "TagsList": { "shape": "S3" }, - "KmsKeyId": {} + "KmsKeyId": {}, + "StartIngestion": { + "type": "boolean" + } } }, "output": { @@ -1215,6 +1218,21 @@ } } }, + "StartEventDataStoreIngestion": { + "input": { + "type": "structure", + "required": [ + "EventDataStore" + ], + "members": { + "EventDataStore": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, "StartImport": { "input": { "type": "structure", @@ -1295,6 +1313,21 @@ }, "idempotent": true }, + "StopEventDataStoreIngestion": { + "input": { + "type": "structure", + "required": [ + "EventDataStore" + ], + "members": { + "EventDataStore": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, "StopImport": { "input": { "type": "structure", diff --git a/apis/cloudtrail-2013-11-01.normal.json b/apis/cloudtrail-2013-11-01.normal.json index 965d9f4f82..5eabc07b0d 100644 --- a/apis/cloudtrail-2013-11-01.normal.json +++ b/apis/cloudtrail-2013-11-01.normal.json @@ -75,7 +75,7 @@ "shape": "ConflictException" } ], - "documentation": "Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).
", + "documentation": "Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).
", "idempotent": true }, "CancelQuery": { @@ -516,7 +516,7 @@ "shape": "InsufficientDependencyServiceAccessPermissionException" } ], - "documentation": "Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail
cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
Deletes a trail. This operation must be called from the Region in which the trail was created. DeleteTrail
cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.
Retrieves settings for one or more trails associated with the current region for your account.
", + "documentation": "Retrieves settings for one or more trails associated with the current Region for your account.
", "idempotent": true }, "GetChannel": { @@ -949,7 +949,7 @@ "shape": "OperationNotPermittedException" } ], - "documentation": "Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
", + "documentation": "Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
", "idempotent": true }, "ListChannels": { @@ -1007,7 +1007,7 @@ "shape": "NoManagementAccountSLRExistsException" } ], - "documentation": "Returns information about all event data stores in the account, in the current region.
", + "documentation": "Returns information about all event data stores in the account, in the current Region.
", "idempotent": true }, "ListImportFailures": { @@ -1094,7 +1094,7 @@ "shape": "InvalidTokenException" } ], - "documentation": "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.
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.
Lists the tags for the trail, event data store, or channel in the current region.
", + "documentation": "Lists the tags for the specified trails, event data stores, or channels in the current Region.
", "idempotent": true }, "ListTrails": { @@ -1258,7 +1258,7 @@ "shape": "OperationNotPermittedException" } ], - "documentation": "Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
Amazon Web Services access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
Amazon Web Services access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput
and RunInstances
API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances
is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput
is a read-only event that doesn't match your event selector. The trail doesn't log the event.
The PutEventSelectors
operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException
exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging management events, Logging data events, and Quotas in CloudTrail in the CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors
or EventSelectors
, but not both. If you apply AdvancedEventSelectors
to a trail, any existing EventSelectors
are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput
and RunInstances
API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances
is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput
is a read-only event that doesn't match your event selector. The trail doesn't log the event.
The PutEventSelectors
operation must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException
exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging management events, Logging data events, and Quotas in CloudTrail in the CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors
or EventSelectors
, but not both. If you apply AdvancedEventSelectors
to a trail, any existing EventSelectors
are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.
Restores a deleted event data store specified by EventDataStore
, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status
must be STOPPED_INGESTION
and the eventCategory
must be Management
, Data
, or ConfigurationItem
.
Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
", + "documentation": "Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.
", "idempotent": true }, "StartQuery": { @@ -1736,6 +1782,52 @@ "documentation": "Starts a CloudTrail Lake query. The required QueryStatement
parameter provides your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri
parameter to deliver the query results to an S3 bucket.
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status
must be ENABLED
and the eventCategory
must be Management
, Data
, or ConfigurationItem
.
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.
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.
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.
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.
Specifies the ARN of the trail, event data store, or channel to which one or more tags will be added.
The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The format of an event data store ARN is: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The format of a channel ARN is: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
Specifies the ARN of the trail, event data store, or channel to which one or more tags will be added.
The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The format of an event data store ARN is: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The format of a channel ARN is: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
" + "documentation": "Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
" }, "OrganizationEnabled": { "shape": "Boolean", @@ -2298,6 +2390,10 @@ "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by alias/
, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
Specifies whether the event data store should start ingesting live events. The default is true.
" } } }, @@ -2322,7 +2418,7 @@ }, "MultiRegionEnabled": { "shape": "Boolean", - "documentation": "Indicates whether the event data store collects events from all regions, or only from the region in which it was created.
" + "documentation": "Indicates whether the event data store collects events from all Regions, or only from the Region in which it was created.
" }, "OrganizationEnabled": { "shape": "Boolean", @@ -2382,7 +2478,7 @@ }, "IsMultiRegionTrail": { "shape": "Boolean", - "documentation": "Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.
" + "documentation": "Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.
" }, "EnableLogFileValidation": { "shape": "Boolean", @@ -2440,7 +2536,7 @@ }, "IsMultiRegionTrail": { "shape": "Boolean", - "documentation": "Specifies whether the trail exists in one region or in all regions.
" + "documentation": "Specifies whether the trail exists in one Region or in all Regions.
" }, "TrailARN": { "shape": "String", @@ -2657,11 +2753,11 @@ "members": { "trailNameList": { "shape": "TrailNameList", - "documentation": "Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
If an empty list is specified, information for the trail in the current region is returned.
If an empty list is specified and IncludeShadowTrails
is false, then information for all trails in the current region is returned.
If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.
If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region and current account. To return information about a trail in another region, you must specify its trail ARN.
Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
If an empty list is specified, information for the trail in the current Region is returned.
If an empty list is specified and IncludeShadowTrails
is false, then information for all trails in the current Region is returned.
If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.
If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.
Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.
" + "documentation": "Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.
" } }, "documentation": "Returns information about the trail.
" @@ -2782,7 +2878,7 @@ }, "Status": { "shape": "EventDataStoreStatus", - "documentation": "The status of an event data store. Values are ENABLED
and PENDING_DELETION
.
The status of an event data store.
", "deprecated": true, "deprecatedMessage": "Status is no longer returned by ListEventDataStores" }, @@ -2794,7 +2890,7 @@ }, "MultiRegionEnabled": { "shape": "Boolean", - "documentation": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
", + "documentation": "Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
", "deprecated": true, "deprecatedMessage": "MultiRegionEnabled is no longer returned by ListEventDataStores" }, @@ -2848,7 +2944,10 @@ "enum": [ "CREATED", "ENABLED", - "PENDING_DELETION" + "PENDING_DELETION", + "STARTING_INGESTION", + "STOPPING_INGESTION", + "STOPPED_INGESTION" ] }, "EventDataStores": { @@ -2866,7 +2965,7 @@ }, "IncludeManagementEvents": { "shape": "Boolean", - "documentation": "Specify if you want your event selector to include management events for your trail.
For more information, see Management Events in the CloudTrail User Guide.
By default, the value is true
.
The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing.
" + "documentation": "Specify if you want your event selector to include management events for your trail.
For more information, see Management Events in the CloudTrail User Guide.
By default, the value is true
.
The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see CloudTrail Pricing.
" }, "DataResources": { "shape": "DataResources", @@ -2874,7 +2973,7 @@ }, "ExcludeManagementEventSources": { "shape": "ExcludeManagementEventSources", - "documentation": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com
or rdsdata.amazonaws.com
. By default, ExcludeManagementEventSources
is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.
An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com
or rdsdata.amazonaws.com
. By default, ExcludeManagementEventSources
is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.
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.
" @@ -2926,7 +3025,7 @@ }, "SourceConfig": { "shape": "SourceConfig", - "documentation": "Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all regions or a single region.
" + "documentation": "Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.
" }, "Destinations": { "shape": "Destinations", @@ -2963,7 +3062,7 @@ }, "Status": { "shape": "EventDataStoreStatus", - "documentation": "The status of an event data store. Values can be ENABLED
and PENDING_DELETION
.
The status of an event data store.
" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", @@ -2971,7 +3070,7 @@ }, "MultiRegionEnabled": { "shape": "Boolean", - "documentation": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
" + "documentation": "Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
" }, "OrganizationEnabled": { "shape": "Boolean", @@ -3210,7 +3309,7 @@ "members": { "Name": { "shape": "String", - "documentation": "Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another Region), you must specify its ARN. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The name of a trail about which you want the current status.
" @@ -3524,7 +3623,7 @@ "members": { "EventDataStores": { "shape": "EventDataStores", - "documentation": "Contains information about event data stores in the account, in the current region.
" + "documentation": "Contains information about event data stores in the account, in the current Region.
" }, "NextToken": { "shape": "PaginationToken", @@ -3699,7 +3798,7 @@ "members": { "ResourceIdList": { "shape": "ResourceIdList", - "documentation": "Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.
" + "documentation": "Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.
Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
Returns the name, ARN, and home region of trails in the current account.
" + "documentation": "Returns the name, ARN, and home Region of trails in the current account.
" }, "NextToken": { "shape": "String", @@ -4143,7 +4242,7 @@ "members": { "ResourceId": { "shape": "String", - "documentation": "Specifies the ARN of the trail, event data store, or channel from which tags should be removed.
Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Example event data store ARN format: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
Specifies the ARN of the trail, event data store, or channel from which tags should be removed.
Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data store was created.
" + "documentation": "Indicates whether the event data store is collecting events from all Regions, or only from the Region in which the event data store was created.
" }, "OrganizationEnabled": { "shape": "Boolean", @@ -4295,7 +4394,7 @@ }, "S3BucketRegion": { "shape": "String", - "documentation": "The region associated with the source S3 bucket.
" + "documentation": "The Region associated with the source S3 bucket.
" }, "S3BucketAccessRoleArn": { "shape": "String", @@ -4327,7 +4426,7 @@ "members": { "ApplyToAllRegions": { "shape": "Boolean", - "documentation": "Specifies whether the channel applies to a single region or to all regions.
" + "documentation": "Specifies whether the channel applies to a single Region or to all Regions.
" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", @@ -4336,6 +4435,22 @@ }, "documentation": "Contains configuration information about the channel.
" }, + "StartEventDataStoreIngestionRequest": { + "type": "structure", + "required": [ + "EventDataStore" + ], + "members": { + "EventDataStore": { + "shape": "EventDataStoreArn", + "documentation": "The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.
" + } + } + }, + "StartEventDataStoreIngestionResponse": { + "type": "structure", + "members": {} + }, "StartImportRequest": { "type": "structure", "members": { @@ -4441,6 +4556,22 @@ } } }, + "StopEventDataStoreIngestionRequest": { + "type": "structure", + "required": [ + "EventDataStore" + ], + "members": { + "EventDataStore": { + "shape": "EventDataStoreArn", + "documentation": "The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.
" + } + } + }, + "StopEventDataStoreIngestionResponse": { + "type": "structure", + "members": {} + }, "StopImportRequest": { "type": "structure", "required": [ @@ -4583,11 +4714,11 @@ }, "IsMultiRegionTrail": { "shape": "Boolean", - "documentation": "Specifies whether the trail exists only in one region or exists in all regions.
" + "documentation": "Specifies whether the trail exists only in one Region or exists in all Regions.
" }, "HomeRegion": { "shape": "String", - "documentation": "The region in which the trail was created.
" + "documentation": "The Region in which the trail was created.
" }, "TrailARN": { "shape": "String", @@ -4640,7 +4771,7 @@ "documentation": "The Amazon Web Services Region in which a trail was created.
" } }, - "documentation": "Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).
" + "documentation": "Information about a CloudTrail trail, including the trail's name, home Region, and Amazon Resource Name (ARN).
" }, "TrailList": { "type": "list", @@ -4727,7 +4858,7 @@ }, "MultiRegionEnabled": { "shape": "Boolean", - "documentation": "Specifies whether an event data store collects events from all regions, or only from the region in which it was created.
" + "documentation": "Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.
" }, "OrganizationEnabled": { "shape": "Boolean", @@ -4760,7 +4891,7 @@ }, "Status": { "shape": "EventDataStoreStatus", - "documentation": "The status of an event data store. Values can be ENABLED
and PENDING_DELETION
.
The status of an event data store.
" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", @@ -4768,7 +4899,7 @@ }, "MultiRegionEnabled": { "shape": "Boolean", - "documentation": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
" + "documentation": "Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
" }, "OrganizationEnabled": { "shape": "Boolean", @@ -4824,7 +4955,7 @@ }, "IsMultiRegionTrail": { "shape": "Boolean", - "documentation": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
" + "documentation": "Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.
" }, "EnableLogFileValidation": { "shape": "Boolean", @@ -4879,7 +5010,7 @@ }, "IsMultiRegionTrail": { "shape": "Boolean", - "documentation": "Specifies whether the trail exists in one region or in all regions.
" + "documentation": "Specifies whether the trail exists in one Region or in all Regions.
" }, "TrailARN": { "shape": "String", @@ -4909,5 +5040,5 @@ "documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" } }, - "documentation": "This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
" + "documentation": "This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
Actions available for CloudTrail trails
The following actions are available for CloudTrail trails.
Actions available for CloudTrail event data stores
The following actions are available for CloudTrail event data stores.
The following additional actions are available for imports.
Actions available for CloudTrail channels
The following actions are available for CloudTrail channels.
Actions available for managing delegated administrators
The following actions are available for adding or a removing a delegated administrator to manage an Organizations organization’s CloudTrail resources.
" } \ No newline at end of file diff --git a/apis/config-2014-11-12.min.json b/apis/config-2014-11-12.min.json index 4264537c90..3d36502a6d 100644 --- a/apis/config-2014-11-12.min.json +++ b/apis/config-2014-11-12.min.json @@ -710,7 +710,7 @@ "type": "structure", "members": { "ConfigRuleNames": { - "shape": "S4l" + "shape": "S4o" }, "ComplianceType": {} } @@ -752,7 +752,7 @@ "type": "structure", "members": { "ConformancePackNames": { - "shape": "S4s" + "shape": "S4v" }, "Limit": { "type": "integer" @@ -800,7 +800,7 @@ "type": "structure", "members": { "ConformancePackNames": { - "shape": "S4s" + "shape": "S4v" }, "Limit": { "type": "integer" @@ -827,14 +827,14 @@ "DeliveryS3Bucket": {}, "DeliveryS3KeyPrefix": {}, "ConformancePackInputParameters": { - "shape": "S58" + "shape": "S5b" }, "LastUpdateRequestedTime": { "type": "timestamp" }, "CreatedBy": {}, "TemplateSSMDocumentDetails": { - "shape": "S5c" + "shape": "S5f" } } } @@ -848,7 +848,7 @@ "type": "structure", "members": { "DeliveryChannelNames": { - "shape": "S5g" + "shape": "S5j" } } }, @@ -862,10 +862,10 @@ "members": { "name": {}, "configSnapshotDeliveryInfo": { - "shape": "S5k" + "shape": "S5n" }, "configHistoryDeliveryInfo": { - "shape": "S5k" + "shape": "S5n" }, "configStreamDeliveryInfo": { "type": "structure", @@ -889,7 +889,7 @@ "type": "structure", "members": { "DeliveryChannelNames": { - "shape": "S5g" + "shape": "S5j" } } }, @@ -899,7 +899,7 @@ "DeliveryChannels": { "type": "list", "member": { - "shape": "S5q" + "shape": "S5t" } } } @@ -910,7 +910,7 @@ "type": "structure", "members": { "OrganizationConfigRuleNames": { - "shape": "S5t" + "shape": "S5w" }, "Limit": { "type": "integer" @@ -949,7 +949,7 @@ "type": "structure", "members": { "OrganizationConfigRuleNames": { - "shape": "S5t" + "shape": "S5w" }, "Limit": { "type": "integer" @@ -972,13 +972,13 @@ "OrganizationConfigRuleName": {}, "OrganizationConfigRuleArn": {}, "OrganizationManagedRuleMetadata": { - "shape": "S63" + "shape": "S66" }, "OrganizationCustomRuleMetadata": { - "shape": "S68" + "shape": "S6b" }, "ExcludedAccounts": { - "shape": "S6b" + "shape": "S6e" }, "LastUpdateTime": { "type": "timestamp" @@ -988,19 +988,19 @@ "members": { "Description": {}, "OrganizationConfigRuleTriggerTypes": { - "shape": "S6d" + "shape": "S6g" }, "InputParameters": {}, "MaximumExecutionFrequency": {}, "ResourceTypesScope": { - "shape": "S66" + "shape": "S69" }, "ResourceIdScope": {}, "TagKeyScope": {}, "TagValueScope": {}, "PolicyRuntime": {}, "DebugLogDeliveryAccounts": { - "shape": "S6f" + "shape": "S6i" } } } @@ -1016,7 +1016,7 @@ "type": "structure", "members": { "OrganizationConformancePackNames": { - "shape": "S6h" + "shape": "S6k" }, "Limit": { "type": "integer" @@ -1055,7 +1055,7 @@ "type": "structure", "members": { "OrganizationConformancePackNames": { - "shape": "S6h" + "shape": "S6k" }, "Limit": { "type": "integer" @@ -1081,10 +1081,10 @@ "DeliveryS3Bucket": {}, "DeliveryS3KeyPrefix": {}, "ConformancePackInputParameters": { - "shape": "S58" + "shape": "S5b" }, "ExcludedAccounts": { - "shape": "S6b" + "shape": "S6e" }, "LastUpdateTime": { "type": "timestamp" @@ -1139,7 +1139,7 @@ "type": "structure", "members": { "RemediationConfigurations": { - "shape": "S6x" + "shape": "S70" } } } @@ -1165,7 +1165,7 @@ "type": "structure", "members": { "RemediationExceptions": { - "shape": "S7d" + "shape": "S7g" }, "NextToken": {} } @@ -1247,7 +1247,7 @@ "RetentionConfigurations": { "type": "list", "member": { - "shape": "S7r" + "shape": "S7u" } }, "NextToken": {} @@ -1284,7 +1284,7 @@ "type": "structure", "members": { "EvaluationResultIdentifier": { - "shape": "S7x" + "shape": "S80" }, "ComplianceType": {}, "ResultRecordedTime": { @@ -1336,7 +1336,7 @@ "members": { "GroupName": {}, "ComplianceSummary": { - "shape": "S86" + "shape": "S89" } } } @@ -1466,7 +1466,7 @@ "type": "structure", "members": { "ConfigurationItem": { - "shape": "S8n" + "shape": "S8q" } } } @@ -1492,7 +1492,7 @@ "type": "structure", "members": { "EvaluationResults": { - "shape": "S8z" + "shape": "S92" }, "NextToken": {} } @@ -1515,7 +1515,7 @@ "type": "structure", "members": { "EvaluationResults": { - "shape": "S8z" + "shape": "S92" }, "NextToken": {} } @@ -1526,7 +1526,7 @@ "type": "structure", "members": { "ComplianceSummary": { - "shape": "S86" + "shape": "S89" } } } @@ -1536,7 +1536,7 @@ "type": "structure", "members": { "ResourceTypes": { - "shape": "S95" + "shape": "S98" } } }, @@ -1550,7 +1550,7 @@ "members": { "ResourceType": {}, "ComplianceSummary": { - "shape": "S86" + "shape": "S89" } } } @@ -1570,7 +1570,7 @@ "type": "structure", "members": { "ConfigRuleNames": { - "shape": "S4l" + "shape": "S4o" }, "ComplianceType": {}, "ResourceType": {}, @@ -1606,7 +1606,7 @@ "members": { "ComplianceType": {}, "EvaluationResultIdentifier": { - "shape": "S7x" + "shape": "S80" }, "ConfigRuleInvokedTime": { "type": "timestamp" @@ -1679,7 +1679,7 @@ "type": "structure", "members": { "resourceTypes": { - "shape": "S95" + "shape": "S98" }, "limit": { "type": "integer" @@ -1853,7 +1853,7 @@ "configurationItems": { "type": "list", "member": { - "shape": "S8n" + "shape": "S8q" } }, "nextToken": {} @@ -1890,10 +1890,10 @@ }, "Compliance": {}, "EvaluationContext": { - "shape": "Sag" + "shape": "Saj" }, "ResourceDetails": { - "shape": "Sai" + "shape": "Sal" } } } @@ -1912,7 +1912,7 @@ "type": "structure", "members": { "StoredQuery": { - "shape": "San" + "shape": "Saq" } } } @@ -2145,7 +2145,7 @@ "type": "structure", "members": { "Tags": { - "shape": "Sbq" + "shape": "Sbt" }, "NextToken": {} } @@ -2162,7 +2162,7 @@ "AuthorizedAccountId": {}, "AuthorizedAwsRegion": {}, "Tags": { - "shape": "Sbv" + "shape": "Sby" } } }, @@ -2186,7 +2186,7 @@ "shape": "S35" }, "Tags": { - "shape": "Sbv" + "shape": "Sby" } } } @@ -2206,7 +2206,7 @@ "shape": "S44" }, "Tags": { - "shape": "Sbv" + "shape": "Sby" } } }, @@ -2245,10 +2245,10 @@ "DeliveryS3Bucket": {}, "DeliveryS3KeyPrefix": {}, "ConformancePackInputParameters": { - "shape": "S58" + "shape": "S5b" }, "TemplateSSMDocumentDetails": { - "shape": "S5c" + "shape": "S5f" } } }, @@ -2267,7 +2267,7 @@ ], "members": { "DeliveryChannel": { - "shape": "S5q" + "shape": "S5t" } } } @@ -2280,7 +2280,7 @@ ], "members": { "Evaluations": { - "shape": "Sc7" + "shape": "Sca" }, "ResultToken": {}, "TestMode": { @@ -2292,7 +2292,7 @@ "type": "structure", "members": { "FailedEvaluations": { - "shape": "Sc7" + "shape": "Sca" } } } @@ -2340,13 +2340,13 @@ "members": { "OrganizationConfigRuleName": {}, "OrganizationManagedRuleMetadata": { - "shape": "S63" + "shape": "S66" }, "OrganizationCustomRuleMetadata": { - "shape": "S68" + "shape": "S6b" }, "ExcludedAccounts": { - "shape": "S6b" + "shape": "S6e" }, "OrganizationCustomPolicyRuleMetadata": { "type": "structure", @@ -2357,12 +2357,12 @@ "members": { "Description": {}, "OrganizationConfigRuleTriggerTypes": { - "shape": "S6d" + "shape": "S6g" }, "InputParameters": {}, "MaximumExecutionFrequency": {}, "ResourceTypesScope": { - "shape": "S66" + "shape": "S69" }, "ResourceIdScope": {}, "TagKeyScope": {}, @@ -2370,7 +2370,7 @@ "PolicyRuntime": {}, "PolicyText": {}, "DebugLogDeliveryAccounts": { - "shape": "S6f" + "shape": "S6i" } } } @@ -2396,10 +2396,10 @@ "DeliveryS3Bucket": {}, "DeliveryS3KeyPrefix": {}, "ConformancePackInputParameters": { - "shape": "S58" + "shape": "S5b" }, "ExcludedAccounts": { - "shape": "S6b" + "shape": "S6e" } } }, @@ -2418,7 +2418,7 @@ ], "members": { "RemediationConfigurations": { - "shape": "S6x" + "shape": "S70" } } }, @@ -2432,7 +2432,7 @@ "members": { "FailureMessage": {}, "FailedItems": { - "shape": "S6x" + "shape": "S70" } } } @@ -2468,7 +2468,7 @@ "members": { "FailureMessage": {}, "FailedItems": { - "shape": "S7d" + "shape": "S7g" } } } @@ -2492,7 +2492,7 @@ "ResourceName": {}, "Configuration": {}, "Tags": { - "shape": "S8p" + "shape": "S8s" } } } @@ -2513,7 +2513,7 @@ "type": "structure", "members": { "RetentionConfiguration": { - "shape": "S7r" + "shape": "S7u" } } } @@ -2526,10 +2526,10 @@ ], "members": { "StoredQuery": { - "shape": "San" + "shape": "Saq" }, "Tags": { - "shape": "Sbv" + "shape": "Sby" } } }, @@ -2563,10 +2563,10 @@ "type": "structure", "members": { "Results": { - "shape": "Sd0" + "shape": "Sd3" }, "QueryInfo": { - "shape": "Sd1" + "shape": "Sd4" }, "NextToken": {} } @@ -2590,10 +2590,10 @@ "type": "structure", "members": { "Results": { - "shape": "Sd0" + "shape": "Sd3" }, "QueryInfo": { - "shape": "Sd1" + "shape": "Sd4" }, "NextToken": {} } @@ -2658,10 +2658,10 @@ ], "members": { "ResourceDetails": { - "shape": "Sai" + "shape": "Sal" }, "EvaluationContext": { - "shape": "Sag" + "shape": "Saj" }, "EvaluationMode": {}, "EvaluationTimeout": { @@ -2698,7 +2698,7 @@ "members": { "ResourceArn": {}, "Tags": { - "shape": "Sbq" + "shape": "Sbt" } } } @@ -2987,22 +2987,39 @@ "type": "boolean" }, "resourceTypes": { - "type": "list", - "member": {} + "shape": "S4i" + }, + "exclusionByResourceTypes": { + "type": "structure", + "members": { + "resourceTypes": { + "shape": "S4i" + } + } + }, + "recordingStrategy": { + "type": "structure", + "members": { + "useOnly": {} + } } } } } }, - "S4l": { + "S4i": { + "type": "list", + "member": {} + }, + "S4o": { "type": "list", "member": {} }, - "S4s": { + "S4v": { "type": "list", "member": {} }, - "S58": { + "S5b": { "type": "list", "member": { "type": "structure", @@ -3016,7 +3033,7 @@ } } }, - "S5c": { + "S5f": { "type": "structure", "required": [ "DocumentName" @@ -3026,11 +3043,11 @@ "DocumentVersion": {} } }, - "S5g": { + "S5j": { "type": "list", "member": {} }, - "S5k": { + "S5n": { "type": "structure", "members": { "lastStatus": {}, @@ -3047,7 +3064,7 @@ } } }, - "S5q": { + "S5t": { "type": "structure", "members": { "name": {}, @@ -3063,11 +3080,11 @@ } } }, - "S5t": { + "S5w": { "type": "list", "member": {} }, - "S63": { + "S66": { "type": "structure", "required": [ "RuleIdentifier" @@ -3078,18 +3095,18 @@ "InputParameters": {}, "MaximumExecutionFrequency": {}, "ResourceTypesScope": { - "shape": "S66" + "shape": "S69" }, "ResourceIdScope": {}, "TagKeyScope": {}, "TagValueScope": {} } }, - "S66": { + "S69": { "type": "list", "member": {} }, - "S68": { + "S6b": { "type": "structure", "required": [ "LambdaFunctionArn", @@ -3105,30 +3122,30 @@ "InputParameters": {}, "MaximumExecutionFrequency": {}, "ResourceTypesScope": { - "shape": "S66" + "shape": "S69" }, "ResourceIdScope": {}, "TagKeyScope": {}, "TagValueScope": {} } }, - "S6b": { + "S6e": { "type": "list", "member": {} }, - "S6d": { + "S6g": { "type": "list", "member": {} }, - "S6f": { + "S6i": { "type": "list", "member": {} }, - "S6h": { + "S6k": { "type": "list", "member": {} }, - "S6x": { + "S70": { "type": "list", "member": { "type": "structure", @@ -3203,7 +3220,7 @@ } } }, - "S7d": { + "S7g": { "type": "list", "member": { "type": "structure", @@ -3223,7 +3240,7 @@ } } }, - "S7r": { + "S7u": { "type": "structure", "required": [ "Name", @@ -3236,7 +3253,7 @@ } } }, - "S7x": { + "S80": { "type": "structure", "members": { "EvaluationResultQualifier": { @@ -3254,7 +3271,7 @@ "ResourceEvaluationId": {} } }, - "S86": { + "S89": { "type": "structure", "members": { "CompliantResourceCount": { @@ -3268,7 +3285,7 @@ } } }, - "S8n": { + "S8q": { "type": "structure", "members": { "version": {}, @@ -3289,7 +3306,7 @@ "type": "timestamp" }, "tags": { - "shape": "S8p" + "shape": "S8s" }, "relatedEvents": { "type": "list", @@ -3313,18 +3330,18 @@ } } }, - "S8p": { + "S8s": { "type": "map", "key": {}, "value": {} }, - "S8z": { + "S92": { "type": "list", "member": { "type": "structure", "members": { "EvaluationResultIdentifier": { - "shape": "S7x" + "shape": "S80" }, "ComplianceType": {}, "ResultRecordedTime": { @@ -3338,17 +3355,17 @@ } } }, - "S95": { + "S98": { "type": "list", "member": {} }, - "Sag": { + "Saj": { "type": "structure", "members": { "EvaluationContextIdentifier": {} } }, - "Sai": { + "Sal": { "type": "structure", "required": [ "ResourceId", @@ -3362,7 +3379,7 @@ "ResourceConfigurationSchemaType": {} } }, - "San": { + "Saq": { "type": "structure", "required": [ "QueryName" @@ -3375,26 +3392,26 @@ "Expression": {} } }, - "Sbq": { + "Sbt": { "type": "list", "member": { - "shape": "Sbr" + "shape": "Sbu" } }, - "Sbr": { + "Sbu": { "type": "structure", "members": { "Key": {}, "Value": {} } }, - "Sbv": { + "Sby": { "type": "list", "member": { - "shape": "Sbr" + "shape": "Sbu" } }, - "Sc7": { + "Sca": { "type": "list", "member": { "type": "structure", @@ -3415,11 +3432,11 @@ } } }, - "Sd0": { + "Sd3": { "type": "list", "member": {} }, - "Sd1": { + "Sd4": { "type": "structure", "members": { "SelectFields": { diff --git a/apis/config-2014-11-12.normal.json b/apis/config-2014-11-12.normal.json index 265b600d01..057b5a8e59 100644 --- a/apis/config-2014-11-12.normal.json +++ b/apis/config-2014-11-12.normal.json @@ -627,7 +627,7 @@ "shape": "NoSuchConfigurationRecorderException" } ], - "documentation": "Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per region in your account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN
or the recordingGroup
of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.
Currently, you can specify only one configuration recorder per region in your account.
If ConfigurationRecorder
does not have the recordingGroup parameter specified, the default is to record all supported resource types.
Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the roleARN
or the recordingGroup
of an existing recorder. For more information, see Managing the Configuration Recorder in the Config Developer Guide.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not have the recordingGroup
field specified, the default is to record all supported resource types.
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role AWSServiceRoleForConfigConforms
in your account. The service-linked role is created only when the role does not exist in your account.
You must specify only one of the follow parameters: TemplateS3Uri
, TemplateBody
or TemplateSSMDocumentDetails
.
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role AWSServiceRoleForConfigConforms
in your account. The service-linked role is created only when the role does not exist in your account.
You must specify only one of the follow parameters: TemplateS3Uri
, TemplateBody
or TemplateSSMDocumentDetails
.
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT
. Once the resource has been evaluated as NON_COMPLIANT
, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT
evaluation result can delete resources before the exception is applied.
Placing an exception can only be performed on resources that are NON_COMPLIANT
. If you use this API for COMPLIANT
resources or resources that are NOT_APPLICABLE
, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT
. Once the resource has been evaluated as NON_COMPLIANT
, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT
evaluation result can delete resources before the exception is applied.
Placing an exception can only be performed on resources that are NON_COMPLIANT
. If you use this API for COMPLIANT
resources or resources that are NOT_APPLICABLE
, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
If you run an aggregation query (i.e., using GROUP BY
or using aggregate functions such as COUNT
; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId
) and do not specify the MaxResults
or the Limit
query parameters, the default page size is set to 500.
If you run a non-aggregation query (i.e., not using GROUP BY
or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role'
) and do not specify the MaxResults
or the Limit
query parameters, the default page size is set to 25.
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
If you run an aggregation query (i.e., using GROUP BY
or using aggregate functions such as COUNT
; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId
) and do not specify the MaxResults
or the Limit
query parameters, the default page size is set to 500.
If you run a non-aggregation query (i.e., not using GROUP BY
or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role'
) and do not specify the MaxResults
or the Limit
query parameters, the default page size is set to 25.
The name of the recorder. By default, Config automatically assigns the name \"default\" when creating the configuration recorder. You cannot change the assigned name.
" + "documentation": "The name of the configuration recorder. Config automatically assigns the name of \"default\" when creating the configuration recorder.
You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.
" }, "roleARN": { "shape": "String", - "documentation": "Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.
While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.
Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.
While the API model does not require this field, the server will reject a request without a defined roleARN
for the configuration recorder.
Pre-existing Config role
If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected.
For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.
Specifies the types of Amazon Web Services resources for which Config records configuration changes.
" + "documentation": "Specifies which resource types Config records for configuration changes.
High Number of Config Evaluations
You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.
If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.
An object that represents the recording of configuration changes of an Amazon Web Services resource.
" + "documentation": "Records configuration changes to specified resource types. For more information about the configuration recorder, see Managing the Configuration Recorder in the Config Developer Guide.
" }, "ConfigurationRecorderList": { "type": "list", @@ -4419,7 +4419,7 @@ "documentation": "The mode of an evaluation. The valid values are Detective or Proactive.
" } }, - "documentation": "Returns a filtered list of Detective or Proactive Config rules. By default, if the filter is not defined, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
" + "documentation": "Returns a filtered list of Detective or Proactive Config rules. By default, if the filter is not defined, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
" }, "DescribeConfigRulesRequest": { "type": "structure", @@ -4434,7 +4434,7 @@ }, "Filters": { "shape": "DescribeConfigRulesFilters", - "documentation": "Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
" + "documentation": "Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
" } }, "documentation": "" @@ -5186,6 +5186,16 @@ "max": 1000, "min": 0 }, + "ExclusionByResourceTypes": { + "type": "structure", + "members": { + "resourceTypes": { + "shape": "ResourceTypeList", + "documentation": "A comma-separated list of resource types to exclude from recording by the configuration recorder.
" + } + }, + "documentation": "Specifies whether the configuration recorder excludes resource types from being recorded. Use the resourceTypes
field to enter a comma-separated list of resource types to exclude as exemptions.
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
" } }, - "documentation": "An object that specifies metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that trigger Config to evaluate Amazon Web Services resources against a rule.
" + "documentation": "metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that trigger Config to evaluate Amazon Web Services resources against a rule.
" }, "OrganizationCustomRuleMetadata": { "type": "structure", @@ -6768,7 +6778,7 @@ "documentation": "The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
" } }, - "documentation": "An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
" + "documentation": "organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
" }, "OrganizationManagedRuleMetadata": { "type": "structure", @@ -6809,7 +6819,7 @@ "documentation": "The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
" } }, - "documentation": "An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
" + "documentation": "organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
" }, "OrganizationResourceDetailedStatus": { "type": "string", @@ -7014,7 +7024,7 @@ "members": { "ConfigurationRecorder": { "shape": "ConfigurationRecorder", - "documentation": "The configuration recorder object that records each configuration change made to the resources.
" + "documentation": "An object for the configuration recorder to record configuration changes for specified resource types.
" } }, "documentation": "The input for the PutConfigurationRecorder action.
" @@ -7405,18 +7415,44 @@ "members": { "allSupported": { "shape": "AllSupported", - "documentation": "Specifies whether Config records configuration changes for every supported type of regional resource.
If you set this option to true
, when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.
If you set this option to true
, you cannot enumerate a list of resourceTypes
.
Specifies whether Config records configuration changes for all supported regional resource types.
If you set this field to true
, when Config adds support for a new type of regional resource, Config starts recording resources of that type automatically.
If you set this field to true
, you cannot enumerate specific resource types to record in the resourceTypes
field of RecordingGroup, or to exclude in the resourceTypes
field of ExclusionByResourceTypes.
Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
Before you can set this option to true
, you must set the allSupported
option to true
.
If you set this option to true
, when Config adds support for a new type of global resource, it starts recording resources of that type automatically.
The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.
" + "documentation": "Specifies whether Config records configuration changes for all supported global resources.
Before you set this field to true
, set the allSupported
field of RecordingGroup to true
. Optionally, you can set the useOnly
field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES
.
If you set this field to true
, when Config adds support for a new type of global resource in the Region where you set up the configuration recorder, Config starts recording resources of that type automatically.
If you set this field to false
but list global resource types in the resourceTypes
field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes
field to false.
If you do not want to record configuration changes to global resource types, make sure to not list them in the resourceTypes
field in addition to setting the includeGlobalResourceTypes
field to false.
A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance
or AWS::CloudTrail::Trail
).
To record all configuration changes, you must set the allSupported
option to true
.
If you set the AllSupported
option to false and populate the ResourceTypes
option with values, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
For a list of valid resourceTypes
values, see the resourceType Value column in Supported Amazon Web Services resource Types.
A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly
field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES
.
To record all configuration changes, set the allSupported
field of RecordingGroup to true
, and either omit this field or don't specify any resource types in this field. If you set the allSupported
field to false
and specify values for resourceTypes
, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
For a list of valid resourceTypes
values, see the Resource Type Value column in Supported Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
An object that specifies how Config excludes resource types from being recorded by the configuration recorder.
To use this option, you must set the useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES
.
An object that specifies the recording strategy for the configuration recorder.
If you set the useOnly
field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regional resource types. You also must set the allSupported
field of RecordingGroup to true
. When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type.
If you set the useOnly
field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types you specify in the resourceTypes
field of RecordingGroup.
If you set the useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for all supported resource types except the resource types that you specify as exemptions to exclude from being recorded in the resourceTypes
field of ExclusionByResourceTypes.
The recordingStrategy
field is optional when you set the allSupported
field of RecordingGroup to true
.
The recordingStrategy
field is optional when you list resource types in the resourceTypes
field of RecordingGroup.
The recordingStrategy
field is required if you list resource types to exclude from recording in the resourceTypes
field of ExclusionByResourceTypes.
If you choose EXCLUSION_BY_RESOURCE_TYPES
for the recording strategy, the exclusionByResourceTypes
field will override other properties in the request.
For example, even if you set includeGlobalResourceTypes
to false, global resource types will still be automatically recorded in this option unless those resource types are specifically listed as exemptions in the resourceTypes
field of exclusionByResourceTypes
.
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.
Specifies which Amazon Web Services resource types Config records for configuration changes. In the recording group, you specify whether you want to record all supported resource types or only specific types of resources.
By default, Config records the configuration changes for all supported types of regional resources that Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.
You can also have Config record supported types of global resources. Global resources are not tied to a specific region and can be used in all regions. The global resource types that Config supports include IAM users, groups, roles, and customer managed policies.
Global resource types onboarded to Config recording after February 2022 will only be recorded in the service's home region for the commercial partition and Amazon Web Services GovCloud (US) West for the GovCloud partition. You can view the Configuration Items for these new global resource types only in their home region and Amazon Web Services GovCloud (US) West.
Supported global resource types onboarded before February 2022 such as AWS::IAM::Group
, AWS::IAM::Policy
, AWS::IAM::Role
, AWS::IAM::User
remain unchanged, and they will continue to deliver Configuration Items in all supported regions in Config. The change will only affect new global resource types onboarded after February 2022.
To record global resource types onboarded after February 2022, enable All Supported Resource Types in the home region of the global resource type you want to record.
If you don't want Config to record all resources, you can specify which types of resources it will record with the resourceTypes
parameter.
For a list of supported resource types, see Supported Resource Types.
For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records.
" + "documentation": "Specifies which resource types Config records for configuration changes. In the recording group, you specify whether you want to record all supported resource types or to include or exclude specific types of resources.
By default, Config records configuration changes for all supported types of Regional resources that Config discovers in the Amazon Web Services Region in which it is running. Regional resources are tied to a Region and can be used only in that Region. Examples of Regional resources are Amazon EC2 instances and Amazon EBS volumes.
You can also have Config record supported types of global resources. Global resources are not tied to a specific Region and can be used in all Regions. The global resource types that Config supports include IAM users, groups, roles, and customer managed policies.
Global resource types onboarded to Config recording after February 2022 will be recorded only in the service's home Region for the commercial partition and Amazon Web Services GovCloud (US-West) for the Amazon Web Services GovCloud (US) partition. You can view the Configuration Items for these new global resource types only in their home Region and Amazon Web Services GovCloud (US-West).
If you don't want Config to record all resources, you can specify which types of resources Config records with the resourceTypes
parameter.
For a list of supported resource types, see Supported Resource Types in the Config developer guide.
For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records in the Config developer guide.
" + }, + "RecordingStrategy": { + "type": "structure", + "members": { + "useOnly": { + "shape": "RecordingStrategyType", + "documentation": "The recording strategy for the configuration recorder.
If you set this option to ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regional resource types. You also must set the allSupported
field of RecordingGroup to true
.
When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide.
If you set this option to INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types that you specify in the resourceTypes
field of RecordingGroup.
If you set this option to EXCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for all supported resource types, except the resource types that you specify as exemptions to exclude from being recorded in the resourceTypes
field of ExclusionByResourceTypes.
The recordingStrategy
field is optional when you set the allSupported
field of RecordingGroup to true
.
The recordingStrategy
field is optional when you list resource types in the resourceTypes
field of RecordingGroup.
The recordingStrategy
field is required if you list resource types to exclude from recording in the resourceTypes
field of ExclusionByResourceTypes.
If you choose EXCLUSION_BY_RESOURCE_TYPES
for the recording strategy, the exclusionByResourceTypes
field will override other properties in the request.
For example, even if you set includeGlobalResourceTypes
to false, global resource types will still be automatically recorded in this option unless those resource types are specifically listed as exemptions in the resourceTypes
field of exclusionByResourceTypes
.
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.
Specifies the recording strategy of the configuration recorder.
" + }, + "RecordingStrategyType": { + "type": "string", + "enum": [ + "ALL_SUPPORTED_RESOURCE_TYPES", + "INCLUSION_BY_RESOURCE_TYPES", + "EXCLUSION_BY_RESOURCE_TYPES" + ] }, "ReevaluateConfigRuleNames": { "type": "list", diff --git a/apis/customer-profiles-2020-08-15.min.json b/apis/customer-profiles-2020-08-15.min.json index fb102c2cc7..7a095cc302 100644 --- a/apis/customer-profiles-2020-08-15.min.json +++ b/apis/customer-profiles-2020-08-15.min.json @@ -47,6 +47,66 @@ } } }, + "CreateCalculatedAttributeDefinition": { + "http": { + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName", + "AttributeDetails", + "Statistic" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "location": "uri", + "locationName": "CalculatedAttributeName" + }, + "DisplayName": {}, + "Description": {}, + "AttributeDetails": { + "shape": "Sb" + }, + "Conditions": { + "shape": "Sf" + }, + "Statistic": {}, + "Tags": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "CalculatedAttributeName": {}, + "DisplayName": {}, + "Description": {}, + "AttributeDetails": { + "shape": "Sb" + }, + "Conditions": { + "shape": "Sf" + }, + "Statistic": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Tags": { + "shape": "Sn" + } + } + } + }, "CreateDomain": { "http": { "requestUri": "/domains/{DomainName}" @@ -68,10 +128,10 @@ "DefaultEncryptionKey": {}, "DeadLetterQueueUrl": {}, "Matching": { - "shape": "Sb" + "shape": "Sw" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } }, @@ -91,7 +151,7 @@ "DefaultEncryptionKey": {}, "DeadLetterQueueUrl": {}, "Matching": { - "shape": "Sv" + "shape": "S1d" }, "CreatedAt": { "type": "timestamp" @@ -100,7 +160,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -134,7 +194,7 @@ ], "members": { "FlowDefinition": { - "shape": "S11" + "shape": "S1i" }, "Batches": { "type": "list", @@ -161,7 +221,7 @@ "ObjectTypeName": {}, "RoleArn": {}, "Tags": { - "shape": "Sr" + "shape": "Sn" } } }, @@ -194,7 +254,7 @@ "AccountNumber": {}, "AdditionalInformation": {}, "PartyType": { - "shape": "S2f" + "shape": "S2v" }, "BusinessName": {}, "FirstName": {}, @@ -202,7 +262,7 @@ "LastName": {}, "BirthDate": {}, "Gender": { - "shape": "S2g" + "shape": "S2w" }, "PhoneNumber": {}, "MobilePhoneNumber": {}, @@ -212,19 +272,19 @@ "PersonalEmailAddress": {}, "BusinessEmailAddress": {}, "Address": { - "shape": "S2h" + "shape": "S2x" }, "ShippingAddress": { - "shape": "S2h" + "shape": "S2x" }, "MailingAddress": { - "shape": "S2h" + "shape": "S2x" }, "BillingAddress": { - "shape": "S2h" + "shape": "S2x" }, "Attributes": { - "shape": "S2i" + "shape": "S2y" }, "PartyTypeString": {}, "GenderString": {} @@ -240,6 +300,33 @@ } } }, + "DeleteCalculatedAttributeDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "location": "uri", + "locationName": "CalculatedAttributeName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, "DeleteDomain": { "http": { "method": "DELETE", @@ -456,10 +543,10 @@ "locationName": "DomainName" }, "Consolidation": { - "shape": "Sh" + "shape": "S12" }, "ConflictResolution": { - "shape": "Sk" + "shape": "S15" }, "MinAllowedConfidenceScoreForMerging": { "type": "double" @@ -485,6 +572,90 @@ } } }, + "GetCalculatedAttributeDefinition": { + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "location": "uri", + "locationName": "CalculatedAttributeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "CalculatedAttributeName": {}, + "DisplayName": {}, + "Description": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Statistic": {}, + "Conditions": { + "shape": "Sf" + }, + "AttributeDetails": { + "shape": "Sb" + }, + "Tags": { + "shape": "Sn" + } + } + } + }, + "GetCalculatedAttributeForProfile": { + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/profile/{ProfileId}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "ProfileId", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "ProfileId": { + "location": "uri", + "locationName": "ProfileId" + }, + "CalculatedAttributeName": { + "location": "uri", + "locationName": "CalculatedAttributeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "CalculatedAttributeName": {}, + "DisplayName": {}, + "IsDataPartial": {}, + "Value": {} + } + } + }, "GetDomain": { "http": { "method": "GET", @@ -534,7 +705,7 @@ } }, "Matching": { - "shape": "Sv" + "shape": "S1d" }, "CreatedAt": { "type": "timestamp" @@ -543,7 +714,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -590,13 +761,13 @@ "type": "timestamp" }, "AutoMerging": { - "shape": "Sg" + "shape": "S11" }, "ExportingLocation": { - "shape": "S38" + "shape": "S3u" }, "JobStats": { - "shape": "S3b" + "shape": "S3x" } } } @@ -638,10 +809,10 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" }, "ObjectTypeNames": { - "shape": "S3e" + "shape": "S40" }, "WorkflowId": {}, "IsUnstructured": { @@ -746,10 +917,10 @@ }, "SourceLastUpdatedTimestampFormat": {}, "Fields": { - "shape": "S3r" + "shape": "S4c" }, "Keys": { - "shape": "S3u" + "shape": "S4f" }, "CreatedAt": { "type": "timestamp" @@ -758,7 +929,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -791,10 +962,10 @@ }, "SourceLastUpdatedTimestampFormat": {}, "Fields": { - "shape": "S3r" + "shape": "S4c" }, "Keys": { - "shape": "S3u" + "shape": "S4f" } } } @@ -986,7 +1157,110 @@ "type": "structure", "members": { "Items": { - "shape": "S4g" + "shape": "S51" + }, + "NextToken": {} + } + } + }, + "ListCalculatedAttributeDefinitions": { + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/calculated-attributes" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CalculatedAttributeName": {}, + "DisplayName": {}, + "Description": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Tags": { + "shape": "Sn" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListCalculatedAttributesForProfile": { + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/profile/{ProfileId}/calculated-attributes" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "ProfileId" + ], + "members": { + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "ProfileId": { + "location": "uri", + "locationName": "ProfileId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CalculatedAttributeName": {}, + "DisplayName": {}, + "IsDataPartial": {}, + "Value": {} + } + } }, "NextToken": {} } @@ -1032,7 +1306,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -1085,10 +1359,10 @@ "type": "timestamp" }, "JobStats": { - "shape": "S3b" + "shape": "S3x" }, "ExportingLocation": { - "shape": "S38" + "shape": "S3u" }, "Message": {} } @@ -1133,7 +1407,7 @@ "type": "structure", "members": { "Items": { - "shape": "S4g" + "shape": "S51" }, "NextToken": {} } @@ -1223,7 +1497,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -1313,7 +1587,7 @@ "type": "structure", "members": { "tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -1462,13 +1736,13 @@ "Uri": {}, "ObjectTypeName": {}, "Tags": { - "shape": "Sr" + "shape": "Sn" }, "FlowDefinition": { - "shape": "S11" + "shape": "S1i" }, "ObjectTypeNames": { - "shape": "S3e" + "shape": "S40" } } }, @@ -1491,10 +1765,10 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" }, "ObjectTypeNames": { - "shape": "S3e" + "shape": "S40" }, "WorkflowId": {}, "IsUnstructured": { @@ -1563,13 +1837,13 @@ }, "SourceLastUpdatedTimestampFormat": {}, "Fields": { - "shape": "S3r" + "shape": "S4c" }, "Keys": { - "shape": "S3u" + "shape": "S4f" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } }, @@ -1592,10 +1866,10 @@ }, "SourceLastUpdatedTimestampFormat": {}, "Fields": { - "shape": "S3r" + "shape": "S4c" }, "Keys": { - "shape": "S3u" + "shape": "S4f" }, "CreatedAt": { "type": "timestamp" @@ -1604,7 +1878,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -1669,7 +1943,7 @@ "AccountNumber": {}, "AdditionalInformation": {}, "PartyType": { - "shape": "S2f" + "shape": "S2v" }, "BusinessName": {}, "FirstName": {}, @@ -1677,7 +1951,7 @@ "LastName": {}, "BirthDate": {}, "Gender": { - "shape": "S2g" + "shape": "S2w" }, "PhoneNumber": {}, "MobilePhoneNumber": {}, @@ -1687,19 +1961,19 @@ "PersonalEmailAddress": {}, "BusinessEmailAddress": {}, "Address": { - "shape": "S2h" + "shape": "S2x" }, "ShippingAddress": { - "shape": "S2h" + "shape": "S2x" }, "MailingAddress": { - "shape": "S2h" + "shape": "S2x" }, "BillingAddress": { - "shape": "S2h" + "shape": "S2x" }, "Attributes": { - "shape": "S2i" + "shape": "S2y" }, "FoundByItems": { "type": "list", @@ -1738,7 +2012,7 @@ "locationName": "resourceArn" }, "tags": { - "shape": "Sr" + "shape": "Sn" } } }, @@ -1776,6 +2050,58 @@ "members": {} } }, + "UpdateCalculatedAttributeDefinition": { + "http": { + "method": "PUT", + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "location": "uri", + "locationName": "CalculatedAttributeName" + }, + "DisplayName": {}, + "Description": {}, + "Conditions": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "CalculatedAttributeName": {}, + "DisplayName": {}, + "Description": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Statistic": {}, + "Conditions": { + "shape": "Sf" + }, + "AttributeDetails": { + "shape": "Sb" + }, + "Tags": { + "shape": "Sn" + } + } + } + }, "UpdateDomain": { "http": { "method": "PUT", @@ -1797,10 +2123,10 @@ "DefaultEncryptionKey": {}, "DeadLetterQueueUrl": {}, "Matching": { - "shape": "Sb" + "shape": "Sw" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } }, @@ -1819,7 +2145,7 @@ "DefaultEncryptionKey": {}, "DeadLetterQueueUrl": {}, "Matching": { - "shape": "Sv" + "shape": "S1d" }, "CreatedAt": { "type": "timestamp" @@ -1828,7 +2154,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" } } } @@ -1853,7 +2179,7 @@ "AdditionalInformation": {}, "AccountNumber": {}, "PartyType": { - "shape": "S2f" + "shape": "S2v" }, "BusinessName": {}, "FirstName": {}, @@ -1861,7 +2187,7 @@ "LastName": {}, "BirthDate": {}, "Gender": { - "shape": "S2g" + "shape": "S2w" }, "PhoneNumber": {}, "MobilePhoneNumber": {}, @@ -1871,16 +2197,16 @@ "PersonalEmailAddress": {}, "BusinessEmailAddress": {}, "Address": { - "shape": "S67" + "shape": "S72" }, "ShippingAddress": { - "shape": "S67" + "shape": "S72" }, "MailingAddress": { - "shape": "S67" + "shape": "S72" }, "BillingAddress": { - "shape": "S67" + "shape": "S72" }, "Attributes": { "type": "map", @@ -1908,6 +2234,65 @@ "member": {} }, "Sb": { + "type": "structure", + "required": [ + "Attributes", + "Expression" + ], + "members": { + "Attributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + } + }, + "Expression": {} + } + }, + "Sf": { + "type": "structure", + "members": { + "Range": { + "type": "structure", + "required": [ + "Value", + "Unit" + ], + "members": { + "Value": { + "type": "integer" + }, + "Unit": {} + } + }, + "ObjectCount": { + "type": "integer" + }, + "Threshold": { + "type": "structure", + "required": [ + "Value", + "Operator" + ], + "members": { + "Value": {}, + "Operator": {} + } + } + } + }, + "Sn": { + "type": "map", + "key": {}, + "value": {} + }, + "Sw": { "type": "structure", "required": [ "Enabled" @@ -1917,17 +2302,17 @@ "type": "boolean" }, "JobSchedule": { - "shape": "Sd" + "shape": "Sy" }, "AutoMerging": { - "shape": "Sg" + "shape": "S11" }, "ExportingConfig": { - "shape": "Sn" + "shape": "S18" } } }, - "Sd": { + "Sy": { "type": "structure", "required": [ "DayOfTheWeek", @@ -1938,7 +2323,7 @@ "Time": {} } }, - "Sg": { + "S11": { "type": "structure", "required": [ "Enabled" @@ -1948,17 +2333,17 @@ "type": "boolean" }, "Consolidation": { - "shape": "Sh" + "shape": "S12" }, "ConflictResolution": { - "shape": "Sk" + "shape": "S15" }, "MinAllowedConfidenceScoreForMerging": { "type": "double" } } }, - "Sh": { + "S12": { "type": "structure", "required": [ "MatchingAttributesList" @@ -1973,7 +2358,7 @@ } } }, - "Sk": { + "S15": { "type": "structure", "required": [ "ConflictResolvingModel" @@ -1983,7 +2368,7 @@ "SourceName": {} } }, - "Sn": { + "S18": { "type": "structure", "members": { "S3Exporting": { @@ -1998,29 +2383,24 @@ } } }, - "Sr": { - "type": "map", - "key": {}, - "value": {} - }, - "Sv": { + "S1d": { "type": "structure", "members": { "Enabled": { "type": "boolean" }, "JobSchedule": { - "shape": "Sd" + "shape": "Sy" }, "AutoMerging": { - "shape": "Sg" + "shape": "S11" }, "ExportingConfig": { - "shape": "Sn" + "shape": "S18" } } }, - "S11": { + "S1i": { "type": "structure", "required": [ "FlowName", @@ -2179,15 +2559,15 @@ } } }, - "S2f": { + "S2v": { "type": "string", "deprecated": true }, - "S2g": { + "S2w": { "type": "string", "deprecated": true }, - "S2h": { + "S2x": { "type": "structure", "members": { "Address1": {}, @@ -2202,12 +2582,12 @@ "PostalCode": {} } }, - "S2i": { + "S2y": { "type": "map", "key": {}, "value": {} }, - "S38": { + "S3u": { "type": "structure", "members": { "S3Exporting": { @@ -2219,7 +2599,7 @@ } } }, - "S3b": { + "S3x": { "type": "structure", "members": { "NumberOfProfilesReviewed": { @@ -2233,12 +2613,12 @@ } } }, - "S3e": { + "S40": { "type": "map", "key": {}, "value": {} }, - "S3r": { + "S4c": { "type": "map", "key": {}, "value": { @@ -2250,7 +2630,7 @@ } } }, - "S3u": { + "S4f": { "type": "map", "key": {}, "value": { @@ -2270,7 +2650,7 @@ } } }, - "S4g": { + "S51": { "type": "list", "member": { "type": "structure", @@ -2291,10 +2671,10 @@ "type": "timestamp" }, "Tags": { - "shape": "Sr" + "shape": "Sn" }, "ObjectTypeNames": { - "shape": "S3e" + "shape": "S40" }, "WorkflowId": {}, "IsUnstructured": { @@ -2303,7 +2683,7 @@ } } }, - "S67": { + "S72": { "type": "structure", "members": { "Address1": {}, diff --git a/apis/customer-profiles-2020-08-15.normal.json b/apis/customer-profiles-2020-08-15.normal.json index 3fb8a14cd2..abaf2fdd46 100644 --- a/apis/customer-profiles-2020-08-15.normal.json +++ b/apis/customer-profiles-2020-08-15.normal.json @@ -44,6 +44,37 @@ ], "documentation": "Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
" }, + "CreateCalculatedAttributeDefinition": { + "name": "CreateCalculatedAttributeDefinition", + "http": { + "method": "POST", + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "shape": "CreateCalculatedAttributeDefinitionRequest" + }, + "output": { + "shape": "CreateCalculatedAttributeDefinitionResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType
and at most, two fields from that ObjectType
.
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
" }, + "DeleteCalculatedAttributeDefinition": { + "name": "DeleteCalculatedAttributeDefinition", + "http": { + "method": "DELETE", + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "shape": "DeleteCalculatedAttributeDefinitionRequest" + }, + "output": { + "shape": "DeleteCalculatedAttributeDefinitionResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.
" + }, "DeleteDomain": { "name": "DeleteDomain", "http": { @@ -385,6 +447,68 @@ ], "documentation": "Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName
or only LastName
), there may be a large number of matches. This increases the chances of erroneous merges.
Provides more information on a calculated attribute definition for Customer Profiles.
" + }, + "GetCalculatedAttributeForProfile": { + "name": "GetCalculatedAttributeForProfile", + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/profile/{ProfileId}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "shape": "GetCalculatedAttributeForProfileRequest" + }, + "output": { + "shape": "GetCalculatedAttributeForProfileResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Retrieve a calculated attribute for a customer profile.
" + }, "GetDomain": { "name": "GetDomain", "http": { @@ -664,6 +788,68 @@ ], "documentation": "Lists all of the integrations associated to a specific URI in the AWS account.
" }, + "ListCalculatedAttributeDefinitions": { + "name": "ListCalculatedAttributeDefinitions", + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/calculated-attributes" + }, + "input": { + "shape": "ListCalculatedAttributeDefinitionsRequest" + }, + "output": { + "shape": "ListCalculatedAttributeDefinitionsResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Lists calculated attribute definitions for Customer Profiles
" + }, + "ListCalculatedAttributesForProfile": { + "name": "ListCalculatedAttributesForProfile", + "http": { + "method": "GET", + "requestUri": "/domains/{DomainName}/profile/{ProfileId}/calculated-attributes" + }, + "input": { + "shape": "ListCalculatedAttributesForProfileRequest" + }, + "output": { + "shape": "ListCalculatedAttributesForProfileResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Retrieve a list of calculated attributes for a customer profile.
" + }, "ListDomains": { "name": "ListDomains", "http": { @@ -1108,6 +1294,37 @@ ], "documentation": "Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
" }, + "UpdateCalculatedAttributeDefinition": { + "name": "UpdateCalculatedAttributeDefinition", + "http": { + "method": "PUT", + "requestUri": "/domains/{DomainName}/calculated-attributes/{CalculatedAttributeName}" + }, + "input": { + "shape": "UpdateCalculatedAttributeDefinitionRequest" + }, + "output": { + "shape": "UpdateCalculatedAttributeDefinitionResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.
" + }, "UpdateDomain": { "name": "UpdateDomain", "http": { @@ -1393,6 +1610,45 @@ }, "documentation": "Workflow step details for APPFLOW_INTEGRATION
workflow.
A list of attribute items specified in the mathematical expression.
" + }, + "Expression": { + "shape": "string1To255", + "documentation": "Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \\\"{ObjectTypeName.AttributeName}\\\".
" + } + }, + "documentation": "Mathematical expression and a list of attribute items specified in that expression.
" + }, + "AttributeItem": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": { + "shape": "attributeName", + "documentation": "The name of an attribute defined in a profile object type.
" + } + }, + "documentation": "The details of a single attribute item specified in the mathematical expression.
" + }, + "AttributeList": { + "type": "list", + "member": { + "shape": "AttributeItem" + }, + "max": 2, + "min": 1 + }, "AttributeSourceIdMap": { "type": "map", "key": { @@ -1471,6 +1727,36 @@ "max": 512, "pattern": ".*" }, + "CalculatedAttributeDefinitionsList": { + "type": "list", + "member": { + "shape": "ListCalculatedAttributeDefinitionItem" + } + }, + "CalculatedAttributesForProfileList": { + "type": "list", + "member": { + "shape": "ListCalculatedAttributeForProfileItem" + } + }, + "Conditions": { + "type": "structure", + "members": { + "Range": { + "shape": "Range", + "documentation": "The relative time period over which data is included in the aggregation.
" + }, + "ObjectCount": { + "shape": "ObjectCount", + "documentation": "The number of profile objects used for the calculated attribute.
" + }, + "Threshold": { + "shape": "Threshold", + "documentation": "The threshold for the calculated attribute.
" + } + }, + "documentation": "The conditions including range, object count, and threshold for the calculated attribute.
" + }, "ConflictResolution": { "type": "structure", "required": [ @@ -1539,6 +1825,94 @@ }, "documentation": "The matching criteria to be used during the auto-merging process.
" }, + "CreateCalculatedAttributeDefinitionRequest": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName", + "AttributeDetails", + "Statistic" + ], + "members": { + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
", + "location": "uri", + "locationName": "CalculatedAttributeName" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "Description": { + "shape": "text", + "documentation": "The description of the calculated attribute.
" + }, + "AttributeDetails": { + "shape": "AttributeDetails", + "documentation": "Mathematical expression and a list of attribute items specified in that expression.
" + }, + "Conditions": { + "shape": "Conditions", + "documentation": "The conditions including range, object count, and threshold for the calculated attribute.
" + }, + "Statistic": { + "shape": "Statistic", + "documentation": "The aggregation operation to perform for the calculated attribute.
" + }, + "Tags": { + "shape": "TagMap", + "documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "CreateCalculatedAttributeDefinitionResponse": { + "type": "structure", + "members": { + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "Description": { + "shape": "text", + "documentation": "The description of the calculated attribute.
" + }, + "AttributeDetails": { + "shape": "AttributeDetails", + "documentation": "Mathematical expression and a list of attribute items specified in that expression.
" + }, + "Conditions": { + "shape": "Conditions", + "documentation": "The conditions including range, object count, and threshold for the calculated attribute.
" + }, + "Statistic": { + "shape": "Statistic", + "documentation": "The aggregation operation to perform for the calculated attribute.
" + }, + "CreatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was created.
" + }, + "LastUpdatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was most recently edited.
" + }, + "Tags": { + "shape": "TagMap", + "documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, "CreateDomainRequest": { "type": "structure", "required": [ @@ -1805,6 +2179,31 @@ "max": 256, "pattern": ".*" }, + "DeleteCalculatedAttributeDefinitionRequest": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
", + "location": "uri", + "locationName": "CalculatedAttributeName" + } + } + }, + "DeleteCalculatedAttributeDefinitionResponse": { + "type": "structure", + "members": {} + }, "DeleteDomainRequest": { "type": "structure", "required": [ @@ -2254,28 +2653,142 @@ "shape": "name", "documentation": "A searchable identifier of a customer profile.
" }, - "Values": { - "shape": "requestValueList", - "documentation": "A list of key values.
" + "Values": { + "shape": "requestValueList", + "documentation": "A list of key values.
" + } + }, + "documentation": "A data type pair that consists of a KeyName
and Values
list that were used to find a profile returned in response to a SearchProfiles request.
The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "Consolidation": { + "shape": "Consolidation", + "documentation": "A list of matching attributes that represent matching criteria.
" + }, + "ConflictResolution": { + "shape": "ConflictResolution", + "documentation": "How the auto-merging process should resolve conflicts between different profiles.
" + }, + "MinAllowedConfidenceScoreForMerging": { + "shape": "Double0To1", + "documentation": "Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
" + } + } + }, + "GetAutoMergingPreviewResponse": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
" + }, + "NumberOfMatchesInSample": { + "shape": "long", + "documentation": "The number of match groups in the domain that have been reviewed in this preview dry run.
" + }, + "NumberOfProfilesInSample": { + "shape": "long", + "documentation": "The number of profiles found in this preview dry run.
" + }, + "NumberOfProfilesWillBeMerged": { + "shape": "long", + "documentation": "The number of profiles that would be merged if this wasn't a preview dry run.
" + } + } + }, + "GetCalculatedAttributeDefinitionRequest": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
", + "location": "uri", + "locationName": "CalculatedAttributeName" + } + } + }, + "GetCalculatedAttributeDefinitionResponse": { + "type": "structure", + "members": { + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "Description": { + "shape": "text", + "documentation": "The description of the calculated attribute.
" + }, + "CreatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was created.
" + }, + "LastUpdatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was most recently edited.
" + }, + "Statistic": { + "shape": "Statistic", + "documentation": "The aggregation operation to perform for the calculated attribute.
" + }, + "Conditions": { + "shape": "Conditions", + "documentation": "The conditions including range, object count, and threshold for the calculated attribute.
" + }, + "AttributeDetails": { + "shape": "AttributeDetails", + "documentation": "Mathematical expression and a list of attribute items specified in that expression.
" + }, + "Tags": { + "shape": "TagMap", + "documentation": "The tags used to organize, track, or control access for this resource.
" } - }, - "documentation": "A data type pair that consists of a KeyName
and Values
list that were used to find a profile returned in response to a SearchProfiles request.
A list of matching attributes that represent matching criteria.
" - }, - "ConflictResolution": { - "shape": "ConflictResolution", - "documentation": "How the auto-merging process should resolve conflicts between different profiles.
" + "ProfileId": { + "shape": "uuid", + "documentation": "The unique identifier of a customer profile.
", + "location": "uri", + "locationName": "ProfileId" }, - "MinAllowedConfidenceScoreForMerging": { - "shape": "Double0To1", - "documentation": "Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
" + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
", + "location": "uri", + "locationName": "CalculatedAttributeName" } } }, - "GetAutoMergingPreviewResponse": { + "GetCalculatedAttributeForProfileResponse": { "type": "structure", - "required": [ - "DomainName" - ], "members": { - "DomainName": { - "shape": "name", - "documentation": "The unique name of the domain.
" + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
" }, - "NumberOfMatchesInSample": { - "shape": "long", - "documentation": "The number of match groups in the domain that have been reviewed in this preview dry run.
" + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" }, - "NumberOfProfilesInSample": { - "shape": "long", - "documentation": "The number of profiles found in this preview dry run.
" + "IsDataPartial": { + "shape": "string1To255", + "documentation": "Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.
" }, - "NumberOfProfilesWillBeMerged": { - "shape": "long", - "documentation": "The number of profiles that would be merged if this wasn't a preview dry run.
" + "Value": { + "shape": "string1To255", + "documentation": "The value of the calculated attribute.
" } } }, @@ -2996,6 +3506,143 @@ } } }, + "ListCalculatedAttributeDefinitionItem": { + "type": "structure", + "members": { + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "Description": { + "shape": "text", + "documentation": "The threshold for the calculated attribute.
" + }, + "CreatedAt": { + "shape": "timestamp", + "documentation": "The threshold for the calculated attribute.
" + }, + "LastUpdatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was most recently edited.
" + }, + "Tags": { + "shape": "TagMap", + "documentation": "The tags used to organize, track, or control access for this resource.
" + } + }, + "documentation": "The details of a single calculated attribute definition.
" + }, + "ListCalculatedAttributeDefinitionsRequest": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "NextToken": { + "shape": "token", + "documentation": "The pagination token from the previous call to ListCalculatedAttributeDefinitions.
", + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "shape": "maxSize100", + "documentation": "The maximum number of calculated attribute definitions returned per page.
", + "location": "querystring", + "locationName": "max-results" + } + } + }, + "ListCalculatedAttributeDefinitionsResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "CalculatedAttributeDefinitionsList", + "documentation": "The list of calculated attribute definitions.
" + }, + "NextToken": { + "shape": "token", + "documentation": "The pagination token from the previous call to ListCalculatedAttributeDefinitions.
" + } + } + }, + "ListCalculatedAttributeForProfileItem": { + "type": "structure", + "members": { + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "IsDataPartial": { + "shape": "string1To255", + "documentation": "Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.
" + }, + "Value": { + "shape": "string1To255", + "documentation": "The value of the calculated attribute.
" + } + }, + "documentation": "The details of a single calculated attribute for a profile.
" + }, + "ListCalculatedAttributesForProfileRequest": { + "type": "structure", + "required": [ + "DomainName", + "ProfileId" + ], + "members": { + "NextToken": { + "shape": "token", + "documentation": "The pagination token from the previous call to ListCalculatedAttributesForProfile.
", + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "shape": "maxSize100", + "documentation": "The maximum number of calculated attributes returned per page.
", + "location": "querystring", + "locationName": "max-results" + }, + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "ProfileId": { + "shape": "uuid", + "documentation": "The unique identifier of a customer profile.
", + "location": "uri", + "locationName": "ProfileId" + } + } + }, + "ListCalculatedAttributesForProfileResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "CalculatedAttributesForProfileList", + "documentation": "The list of calculated attributes.
" + }, + "NextToken": { + "shape": "token", + "documentation": "The pagination token from the previous call to ListCalculatedAttributesForProfile.
" + } + } + }, "ListDomainItem": { "type": "structure", "required": [ @@ -3356,7 +4003,7 @@ }, "ObjectFilter": { "shape": "ObjectFilter", - "documentation": "Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.
" + "documentation": "Applies a filter to the response to include profile objects with the specified index values.
" } } }, @@ -3652,6 +4299,11 @@ "max": 512, "pattern": "\\S+" }, + "ObjectCount": { + "type": "integer", + "max": 100, + "min": 1 + }, "ObjectFilter": { "type": "structure", "required": [ @@ -3661,14 +4313,14 @@ "members": { "KeyName": { "shape": "name", - "documentation": "A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.
" + "documentation": "A searchable identifier of a profile object. The predefined keys you can use to search for _asset
include: _assetId
, _assetName
, and _serialNumber
. The predefined keys you can use to search for _case
include: _caseId
. The predefined keys you can use to search for _order
include: _orderId
.
A list of key values.
" } }, - "documentation": "The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.
" + "documentation": "The filter applied to ListProfileObjects
response to include profile objects with the specified index values.
The amount of time of the specified unit.
" + }, + "Unit": { + "shape": "Unit", + "documentation": "The unit of time.
" + } + }, + "documentation": "The relative time period over which data is included in the aggregation.
" + }, "RoleArn": { "type": "string", "max": 512, @@ -4479,6 +5158,19 @@ "shape": "StandardIdentifier" } }, + "Statistic": { + "type": "string", + "enum": [ + "FIRST_OCCURRENCE", + "LAST_OCCURRENCE", + "COUNT", + "SUM", + "MINIMUM", + "MAXIMUM", + "AVERAGE", + "MAX_OCCURRENCE" + ] + }, "Status": { "type": "string", "enum": [ @@ -4605,6 +5297,24 @@ "shape": "Task" } }, + "Threshold": { + "type": "structure", + "required": [ + "Value", + "Operator" + ], + "members": { + "Value": { + "shape": "string1To255", + "documentation": "The value of the threshold.
" + }, + "Operator": { + "shape": "Operator", + "documentation": "The operator of the threshold.
" + } + }, + "documentation": "The threshold for the calculated attribute.
" + }, "Timezone": { "type": "string", "max": 256, @@ -4645,6 +5355,12 @@ "OnDemand" ] }, + "Unit": { + "type": "string", + "enum": [ + "DAYS" + ] + }, "UntagResourceRequest": { "type": "structure", "required": [ @@ -4725,6 +5441,80 @@ "shape": "string0To255" } }, + "UpdateCalculatedAttributeDefinitionRequest": { + "type": "structure", + "required": [ + "DomainName", + "CalculatedAttributeName" + ], + "members": { + "DomainName": { + "shape": "name", + "documentation": "The unique name of the domain.
", + "location": "uri", + "locationName": "DomainName" + }, + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
", + "location": "uri", + "locationName": "CalculatedAttributeName" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "Description": { + "shape": "text", + "documentation": "The description of the calculated attribute.
" + }, + "Conditions": { + "shape": "Conditions", + "documentation": "The conditions including range, object count, and threshold for the calculated attribute.
" + } + } + }, + "UpdateCalculatedAttributeDefinitionResponse": { + "type": "structure", + "members": { + "CalculatedAttributeName": { + "shape": "typeName", + "documentation": "The unique name of the calculated attribute.
" + }, + "DisplayName": { + "shape": "displayName", + "documentation": "The display name of the calculated attribute.
" + }, + "Description": { + "shape": "text", + "documentation": "The description of the calculated attribute.
" + }, + "CreatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was created.
" + }, + "LastUpdatedAt": { + "shape": "timestamp", + "documentation": "The timestamp of when the calculated attribute definition was most recently edited.
" + }, + "Statistic": { + "shape": "Statistic", + "documentation": "The aggregation operation to perform for the calculated attribute.
" + }, + "Conditions": { + "shape": "Conditions", + "documentation": "The conditions including range, object count, and threshold for the calculated attribute.
" + }, + "AttributeDetails": { + "shape": "AttributeDetails", + "documentation": "The mathematical expression and a list of attribute items specified in that expression.
" + }, + "Tags": { + "shape": "TagMap", + "documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, "UpdateDomainRequest": { "type": "structure", "required": [ @@ -4924,6 +5714,11 @@ } } }, + "Value": { + "type": "integer", + "max": 366, + "min": 1 + }, "WorkflowAttributes": { "type": "structure", "members": { @@ -5012,9 +5807,21 @@ "max": 4, "min": 1 }, + "attributeName": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[a-zA-Z0-9_.-]+$" + }, "boolean": { "type": "boolean" }, + "displayName": { + "type": "string", + "max": 255, + "min": 1, + "pattern": "^[a-zA-Z_][a-zA-Z_0-9-\\s]*$" + }, "encryptionKey": { "type": "string", "max": 255, diff --git a/apis/ec2-2016-11-15.min.json b/apis/ec2-2016-11-15.min.json index 7e1389a7b9..28025659fc 100644 --- a/apis/ec2-2016-11-15.min.json +++ b/apis/ec2-2016-11-15.min.json @@ -6977,6 +6977,9 @@ "DeregisterInstanceEventNotificationAttributes": { "input": { "type": "structure", + "required": [ + "InstanceTagAttribute" + ], "members": { "DryRun": { "type": "boolean" @@ -22293,6 +22296,9 @@ "RegisterInstanceEventNotificationAttributes": { "input": { "type": "structure", + "required": [ + "InstanceTagAttribute" + ], "members": { "DryRun": { "type": "boolean" diff --git a/apis/ec2-2016-11-15.normal.json b/apis/ec2-2016-11-15.normal.json index ab62a93383..90bcf391dc 100644 --- a/apis/ec2-2016-11-15.normal.json +++ b/apis/ec2-2016-11-15.normal.json @@ -20398,6 +20398,9 @@ }, "DeregisterInstanceEventNotificationAttributesRequest": { "type": "structure", + "required": [ + "InstanceTagAttribute" + ], "members": { "DryRun": { "shape": "Boolean", @@ -48743,6 +48746,9 @@ }, "RegisterInstanceEventNotificationAttributesRequest": { "type": "structure", + "required": [ + "InstanceTagAttribute" + ], "members": { "DryRun": { "shape": "Boolean", diff --git a/apis/finspace-2021-03-12.min.json b/apis/finspace-2021-03-12.min.json index 702fc0f74f..361a26d61a 100644 --- a/apis/finspace-2021-03-12.min.json +++ b/apis/finspace-2021-03-12.min.json @@ -64,6 +64,274 @@ } } }, + "CreateKxChangeset": { + "http": { + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "changeRequests", + "clientToken" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "location": "uri", + "locationName": "databaseName" + }, + "changeRequests": { + "shape": "Ss" + }, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "changesetId": {}, + "databaseName": {}, + "environmentId": {}, + "changeRequests": { + "shape": "Ss" + }, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "status": {}, + "errorInfo": { + "shape": "S12" + } + } + } + }, + "CreateKxCluster": { + "http": { + "requestUri": "/kx/environments/{environmentId}/clusters" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "clusterName", + "clusterType", + "capacityConfiguration", + "releaseLabel", + "azMode" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": {}, + "clusterType": {}, + "databases": { + "shape": "S1a" + }, + "cacheStorageConfigurations": { + "shape": "S1g" + }, + "autoScalingConfiguration": { + "shape": "S1j" + }, + "clusterDescription": {}, + "capacityConfiguration": { + "shape": "S1p" + }, + "releaseLabel": {}, + "vpcConfiguration": { + "shape": "S1s" + }, + "initializationScript": {}, + "commandLineArguments": { + "shape": "S20" + }, + "code": { + "shape": "S24" + }, + "executionRole": {}, + "savedownStorageConfiguration": { + "shape": "S29" + }, + "azMode": {}, + "availabilityZoneId": {}, + "tags": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "environmentId": {}, + "status": {}, + "statusReason": {}, + "clusterName": {}, + "clusterType": {}, + "databases": { + "shape": "S1a" + }, + "cacheStorageConfigurations": { + "shape": "S1g" + }, + "autoScalingConfiguration": { + "shape": "S1j" + }, + "clusterDescription": {}, + "capacityConfiguration": { + "shape": "S1p" + }, + "releaseLabel": {}, + "vpcConfiguration": { + "shape": "S1s" + }, + "initializationScript": {}, + "commandLineArguments": { + "shape": "S20" + }, + "code": { + "shape": "S24" + }, + "executionRole": {}, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "savedownStorageConfiguration": { + "shape": "S29" + }, + "azMode": {}, + "availabilityZoneId": {}, + "createdTimestamp": { + "type": "timestamp" + } + } + } + }, + "CreateKxDatabase": { + "http": { + "requestUri": "/kx/environments/{environmentId}/databases" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "clientToken" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": {}, + "description": {}, + "tags": { + "shape": "S5" + }, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "databaseName": {}, + "databaseArn": {}, + "environmentId": {}, + "description": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + } + } + } + }, + "CreateKxEnvironment": { + "http": { + "requestUri": "/kx/environments" + }, + "input": { + "type": "structure", + "required": [ + "name", + "kmsKeyId" + ], + "members": { + "name": {}, + "description": {}, + "kmsKeyId": {}, + "tags": { + "shape": "S5" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "status": {}, + "environmentId": {}, + "description": {}, + "environmentArn": {}, + "kmsKeyId": {}, + "creationTimestamp": { + "type": "timestamp" + } + } + } + }, + "CreateKxUser": { + "http": { + "requestUri": "/kx/environments/{environmentId}/users" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "userName", + "iamRole" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "userName": {}, + "iamRole": {}, + "tags": { + "shape": "S5" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "userName": {}, + "userArn": {}, + "environmentId": {}, + "iamRole": {} + } + } + }, "DeleteEnvironment": { "http": { "method": "DELETE", @@ -83,43 +351,761 @@ }, "output": { "type": "structure", - "members": {} + "members": {} + } + }, + "DeleteKxCluster": { + "http": { + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "clusterName" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "location": "uri", + "locationName": "clusterName" + }, + "clientToken": { + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteKxDatabase": { + "http": { + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "clientToken" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "location": "uri", + "locationName": "databaseName" + }, + "clientToken": { + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteKxEnvironment": { + "http": { + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteKxUser": { + "http": { + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}/users/{userName}" + }, + "input": { + "type": "structure", + "required": [ + "userName", + "environmentId" + ], + "members": { + "userName": { + "location": "uri", + "locationName": "userName" + }, + "environmentId": { + "location": "uri", + "locationName": "environmentId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetEnvironment": { + "http": { + "method": "GET", + "requestUri": "/environment/{environmentId}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + } + } + }, + "output": { + "type": "structure", + "members": { + "environment": { + "shape": "S36" + } + } + } + }, + "GetKxChangeset": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "changesetId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "location": "uri", + "locationName": "databaseName" + }, + "changesetId": { + "location": "uri", + "locationName": "changesetId" + } + } + }, + "output": { + "type": "structure", + "members": { + "changesetId": {}, + "databaseName": {}, + "environmentId": {}, + "changeRequests": { + "shape": "Ss" + }, + "createdTimestamp": { + "type": "timestamp" + }, + "activeFromTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "status": {}, + "errorInfo": { + "shape": "S12" + } + } + } + }, + "GetKxCluster": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "clusterName" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "location": "uri", + "locationName": "clusterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "statusReason": {}, + "clusterName": {}, + "clusterType": {}, + "databases": { + "shape": "S1a" + }, + "cacheStorageConfigurations": { + "shape": "S1g" + }, + "autoScalingConfiguration": { + "shape": "S1j" + }, + "clusterDescription": {}, + "capacityConfiguration": { + "shape": "S1p" + }, + "releaseLabel": {}, + "vpcConfiguration": { + "shape": "S1s" + }, + "initializationScript": {}, + "commandLineArguments": { + "shape": "S20" + }, + "code": { + "shape": "S24" + }, + "executionRole": {}, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "savedownStorageConfiguration": { + "shape": "S29" + }, + "azMode": {}, + "availabilityZoneId": {}, + "createdTimestamp": { + "type": "timestamp" + } + } + } + }, + "GetKxConnectionString": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/connectionString" + }, + "input": { + "type": "structure", + "required": [ + "userArn", + "environmentId", + "clusterName" + ], + "members": { + "userArn": { + "location": "querystring", + "locationName": "userArn" + }, + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "location": "querystring", + "locationName": "clusterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "signedConnectionString": { + "type": "string", + "sensitive": true + } + } + } + }, + "GetKxDatabase": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "location": "uri", + "locationName": "databaseName" + } + } + }, + "output": { + "type": "structure", + "members": { + "databaseName": {}, + "databaseArn": {}, + "environmentId": {}, + "description": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "lastCompletedChangesetId": {}, + "numBytes": { + "type": "long" + }, + "numChangesets": { + "type": "integer" + }, + "numFiles": { + "type": "integer" + } + } + } + }, + "GetKxEnvironment": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "environmentId": {}, + "awsAccountId": {}, + "status": {}, + "tgwStatus": {}, + "dnsStatus": {}, + "errorMessage": {}, + "description": {}, + "environmentArn": {}, + "kmsKeyId": {}, + "dedicatedServiceAccountId": {}, + "transitGatewayConfiguration": { + "shape": "S3p" + }, + "customDNSConfiguration": { + "shape": "S3s" + }, + "creationTimestamp": { + "type": "timestamp" + }, + "updateTimestamp": { + "type": "timestamp" + }, + "availabilityZoneIds": { + "shape": "S3w" + }, + "certificateAuthorityArn": {} + } + } + }, + "GetKxUser": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/users/{userName}" + }, + "input": { + "type": "structure", + "required": [ + "userName", + "environmentId" + ], + "members": { + "userName": { + "location": "uri", + "locationName": "userName" + }, + "environmentId": { + "location": "uri", + "locationName": "environmentId" + } + } + }, + "output": { + "type": "structure", + "members": { + "userName": {}, + "userArn": {}, + "environmentId": {}, + "iamRole": {} + } + } + }, + "ListEnvironments": { + "http": { + "method": "GET", + "requestUri": "/environment" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "environments": { + "type": "list", + "member": { + "shape": "S36" + } + }, + "nextToken": {} + } + } + }, + "ListKxChangesets": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "location": "uri", + "locationName": "databaseName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "kxChangesets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "changesetId": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "activeFromTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "status": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListKxClusterNodes": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes" + }, + "input": { + "type": "structure", + "required": [ + "clusterName", + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "location": "uri", + "locationName": "clusterName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "nodes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "nodeId": {}, + "availabilityZoneId": {}, + "launchTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListKxClusters": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/clusters" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterType": { + "location": "querystring", + "locationName": "clusterType" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "kxClusterSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "status": {}, + "statusReason": {}, + "clusterName": {}, + "clusterType": {}, + "clusterDescription": {}, + "releaseLabel": {}, + "initializationScript": {}, + "executionRole": {}, + "azMode": {}, + "availabilityZoneId": {}, + "lastModifiedTimestamp": { + "type": "timestamp" + }, + "createdTimestamp": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListKxDatabases": { + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "kxDatabases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "databaseName": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } } }, - "GetEnvironment": { + "ListKxEnvironments": { "http": { "method": "GET", - "requestUri": "/environment/{environmentId}" + "requestUri": "/kx/environments" }, "input": { "type": "structure", - "required": [ - "environmentId" - ], "members": { - "environmentId": { - "location": "uri", - "locationName": "environmentId" + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" } } }, "output": { "type": "structure", "members": { - "environment": { - "shape": "Ss" - } + "environments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "environmentId": {}, + "awsAccountId": {}, + "status": {}, + "tgwStatus": {}, + "dnsStatus": {}, + "errorMessage": {}, + "description": {}, + "environmentArn": {}, + "kmsKeyId": {}, + "dedicatedServiceAccountId": {}, + "transitGatewayConfiguration": { + "shape": "S3p" + }, + "customDNSConfiguration": { + "shape": "S3s" + }, + "creationTimestamp": { + "type": "timestamp" + }, + "updateTimestamp": { + "type": "timestamp" + }, + "availabilityZoneIds": { + "shape": "S3w" + }, + "certificateAuthorityArn": {} + } + } + }, + "nextToken": {} } } }, - "ListEnvironments": { + "ListKxUsers": { "http": { "method": "GET", - "requestUri": "/environment" + "requestUri": "/kx/environments/{environmentId}/users" }, "input": { "type": "structure", + "required": [ + "environmentId" + ], "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, "nextToken": { "location": "querystring", "locationName": "nextToken" @@ -134,10 +1120,21 @@ "output": { "type": "structure", "members": { - "environments": { + "users": { "type": "list", "member": { - "shape": "Ss" + "type": "structure", + "members": { + "userArn": {}, + "userName": {}, + "iamRole": {}, + "createTimestamp": { + "type": "timestamp" + }, + "updateTimestamp": { + "type": "timestamp" + } + } } }, "nextToken": {} @@ -251,10 +1248,224 @@ "type": "structure", "members": { "environment": { - "shape": "Ss" + "shape": "S36" + } + } + } + }, + "UpdateKxClusterDatabases": { + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "clusterName", + "databases" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "location": "uri", + "locationName": "clusterName" + }, + "clientToken": {}, + "databases": { + "shape": "S1a" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateKxDatabase": { + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "clientToken" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "location": "uri", + "locationName": "databaseName" + }, + "description": {}, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "databaseName": {}, + "environmentId": {}, + "description": {}, + "lastModifiedTimestamp": { + "type": "timestamp" + } + } + } + }, + "UpdateKxEnvironment": { + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "name": {}, + "description": {}, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "environmentId": {}, + "awsAccountId": {}, + "status": {}, + "tgwStatus": {}, + "dnsStatus": {}, + "errorMessage": {}, + "description": {}, + "environmentArn": {}, + "kmsKeyId": {}, + "dedicatedServiceAccountId": {}, + "transitGatewayConfiguration": { + "shape": "S3p" + }, + "customDNSConfiguration": { + "shape": "S3s" + }, + "creationTimestamp": { + "type": "timestamp" + }, + "updateTimestamp": { + "type": "timestamp" + }, + "availabilityZoneIds": { + "shape": "S3w" + } + } + } + }, + "UpdateKxEnvironmentNetwork": { + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/network" + }, + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "transitGatewayConfiguration": { + "shape": "S3p" + }, + "customDNSConfiguration": { + "shape": "S3s" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "environmentId": {}, + "awsAccountId": {}, + "status": {}, + "tgwStatus": {}, + "dnsStatus": {}, + "errorMessage": {}, + "description": {}, + "environmentArn": {}, + "kmsKeyId": {}, + "dedicatedServiceAccountId": {}, + "transitGatewayConfiguration": { + "shape": "S3p" + }, + "customDNSConfiguration": { + "shape": "S3s" + }, + "creationTimestamp": { + "type": "timestamp" + }, + "updateTimestamp": { + "type": "timestamp" + }, + "availabilityZoneIds": { + "shape": "S3w" } } } + }, + "UpdateKxUser": { + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/users/{userName}" + }, + "input": { + "type": "structure", + "required": [ + "environmentId", + "userName", + "iamRole" + ], + "members": { + "environmentId": { + "location": "uri", + "locationName": "environmentId" + }, + "userName": { + "location": "uri", + "locationName": "userName" + }, + "iamRole": {}, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "userName": {}, + "userArn": {}, + "environmentId": {}, + "iamRole": {} + } + } } }, "shapes": { @@ -279,6 +1490,150 @@ } }, "Ss": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "changeType", + "dbPath" + ], + "members": { + "changeType": {}, + "s3Path": {}, + "dbPath": {} + } + } + }, + "S12": { + "type": "structure", + "members": { + "errorMessage": {}, + "errorType": {} + } + }, + "S1a": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "databaseName" + ], + "members": { + "databaseName": {}, + "cacheConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "cacheType", + "dbPaths" + ], + "members": { + "cacheType": {}, + "dbPaths": { + "type": "list", + "member": {} + } + } + } + }, + "changesetId": {} + } + } + }, + "S1g": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "type", + "size" + ], + "members": { + "type": {}, + "size": { + "type": "integer" + } + } + } + }, + "S1j": { + "type": "structure", + "members": { + "minNodeCount": { + "type": "integer" + }, + "maxNodeCount": { + "type": "integer" + }, + "autoScalingMetric": {}, + "metricTarget": { + "type": "double" + }, + "scaleInCooldownSeconds": { + "type": "double" + }, + "scaleOutCooldownSeconds": { + "type": "double" + } + } + }, + "S1p": { + "type": "structure", + "members": { + "nodeType": {}, + "nodeCount": { + "type": "integer" + } + } + }, + "S1s": { + "type": "structure", + "members": { + "vpcId": {}, + "securityGroupIds": { + "type": "list", + "member": {} + }, + "subnetIds": { + "type": "list", + "member": {} + }, + "ipAddressType": {} + } + }, + "S20": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "S24": { + "type": "structure", + "members": { + "s3Bucket": {}, + "s3Key": {}, + "s3ObjectVersion": {} + } + }, + "S29": { + "type": "structure", + "required": [ + "type", + "size" + ], + "members": { + "type": {}, + "size": { + "type": "integer" + } + } + }, + "S36": { "type": "structure", "members": { "name": {}, @@ -296,6 +1651,35 @@ "shape": "S9" } } + }, + "S3p": { + "type": "structure", + "required": [ + "transitGatewayID", + "routableCIDRSpace" + ], + "members": { + "transitGatewayID": {}, + "routableCIDRSpace": {} + } + }, + "S3s": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "customDNSServerName", + "customDNSServerIP" + ], + "members": { + "customDNSServerName": {}, + "customDNSServerIP": {} + } + } + }, + "S3w": { + "type": "list", + "member": {} } } } \ No newline at end of file diff --git a/apis/finspace-2021-03-12.normal.json b/apis/finspace-2021-03-12.normal.json index 2c29ec3ff4..04554610b7 100644 --- a/apis/finspace-2021-03-12.normal.json +++ b/apis/finspace-2021-03-12.normal.json @@ -47,53 +47,136 @@ ], "documentation": "Create a new FinSpace environment.
" }, - "DeleteEnvironment": { - "name": "DeleteEnvironment", + "CreateKxChangeset": { + "name": "CreateKxChangeset", "http": { - "method": "DELETE", - "requestUri": "/environment/{environmentId}" + "method": "POST", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets" }, "input": { - "shape": "DeleteEnvironmentRequest" + "shape": "CreateKxChangesetRequest" }, "output": { - "shape": "DeleteEnvironmentResponse" + "shape": "CreateKxChangesetResponse" }, "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, { "shape": "ResourceNotFoundException" }, + { + "shape": "ConflictException" + }, + { + "shape": "LimitExceededException" + } + ], + "documentation": "Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
" + }, + "CreateKxCluster": { + "name": "CreateKxCluster", + "http": { + "method": "POST", + "requestUri": "/kx/environments/{environmentId}/clusters" + }, + "input": { + "shape": "CreateKxClusterRequest" + }, + "output": { + "shape": "CreateKxClusterResponse" + }, + "errors": [ { "shape": "InternalServerException" }, { - "shape": "AccessDeniedException" + "shape": "ValidationException" }, { "shape": "ThrottlingException" }, { - "shape": "ValidationException" + "shape": "AccessDeniedException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" } ], - "documentation": "Delete an FinSpace environment.
" + "documentation": "Creates a new kdb cluster.
" }, - "GetEnvironment": { - "name": "GetEnvironment", + "CreateKxDatabase": { + "name": "CreateKxDatabase", "http": { - "method": "GET", - "requestUri": "/environment/{environmentId}" + "method": "POST", + "requestUri": "/kx/environments/{environmentId}/databases" }, "input": { - "shape": "GetEnvironmentRequest" + "shape": "CreateKxDatabaseRequest" }, "output": { - "shape": "GetEnvironmentResponse" + "shape": "CreateKxDatabaseResponse" }, "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceAlreadyExistsException" + }, { "shape": "ResourceNotFoundException" }, + { + "shape": "LimitExceededException" + } + ], + "documentation": "Creates a new kdb database in the environment.
" + }, + "CreateKxEnvironment": { + "name": "CreateKxEnvironment", + "http": { + "method": "POST", + "requestUri": "/kx/environments" + }, + "input": { + "shape": "CreateKxEnvironmentRequest" + }, + "output": { + "shape": "CreateKxEnvironmentResponse" + }, + "errors": [ { "shape": "InternalServerException" }, @@ -102,118 +185,175 @@ }, { "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Returns the FinSpace environment object.
" + "documentation": "Creates a managed kdb environment for the account.
" }, - "ListEnvironments": { - "name": "ListEnvironments", + "CreateKxUser": { + "name": "CreateKxUser", "http": { - "method": "GET", - "requestUri": "/environment" + "method": "POST", + "requestUri": "/kx/environments/{environmentId}/users" }, "input": { - "shape": "ListEnvironmentsRequest" + "shape": "CreateKxUserRequest" }, "output": { - "shape": "ListEnvironmentsResponse" + "shape": "CreateKxUserResponse" }, "errors": [ + { + "shape": "ResourceNotFoundException" + }, { "shape": "InternalServerException" }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, { "shape": "ValidationException" + }, + { + "shape": "ResourceAlreadyExistsException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "A list of all of your FinSpace environments.
" + "documentation": "Creates a user in FinSpace kdb environment with an associated IAM role.
" }, - "ListTagsForResource": { - "name": "ListTagsForResource", + "DeleteEnvironment": { + "name": "DeleteEnvironment", "http": { - "method": "GET", - "requestUri": "/tags/{resourceArn}" + "method": "DELETE", + "requestUri": "/environment/{environmentId}" }, "input": { - "shape": "ListTagsForResourceRequest" + "shape": "DeleteEnvironmentRequest" }, "output": { - "shape": "ListTagsForResourceResponse" + "shape": "DeleteEnvironmentResponse" }, "errors": [ + { + "shape": "ResourceNotFoundException" + }, { "shape": "InternalServerException" }, { - "shape": "InvalidRequestException" + "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" } ], - "documentation": "A list of all tags for a resource.
" + "documentation": "Delete an FinSpace environment.
" }, - "TagResource": { - "name": "TagResource", + "DeleteKxCluster": { + "name": "DeleteKxCluster", "http": { - "method": "POST", - "requestUri": "/tags/{resourceArn}" + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}" }, "input": { - "shape": "TagResourceRequest" + "shape": "DeleteKxClusterRequest" }, "output": { - "shape": "TagResourceResponse" + "shape": "DeleteKxClusterResponse" }, "errors": [ { "shape": "InternalServerException" }, { - "shape": "InvalidRequestException" + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" }, { "shape": "ResourceNotFoundException" } ], - "documentation": "Adds metadata tags to a FinSpace resource.
" + "documentation": "Deletes a kdb cluster.
" }, - "UntagResource": { - "name": "UntagResource", + "DeleteKxDatabase": { + "name": "DeleteKxDatabase", "http": { "method": "DELETE", - "requestUri": "/tags/{resourceArn}" + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}" }, "input": { - "shape": "UntagResourceRequest" + "shape": "DeleteKxDatabaseRequest" }, "output": { - "shape": "UntagResourceResponse" + "shape": "DeleteKxDatabaseResponse" }, "errors": [ { "shape": "InternalServerException" }, { - "shape": "InvalidRequestException" + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Removes metadata tags from a FinSpace resource.
" + "documentation": "Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
" }, - "UpdateEnvironment": { - "name": "UpdateEnvironment", + "DeleteKxEnvironment": { + "name": "DeleteKxEnvironment", "http": { - "method": "PUT", - "requestUri": "/environment/{environmentId}" + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}" }, "input": { - "shape": "UpdateEnvironmentRequest" + "shape": "DeleteKxEnvironmentRequest" }, "output": { - "shape": "UpdateEnvironmentResponse" + "shape": "DeleteKxEnvironmentResponse" }, "errors": [ { @@ -232,257 +372,2958 @@ "shape": "ValidationException" } ], - "documentation": "Update your FinSpace environment.
" - } - }, - "shapes": { - "AttributeMap": { - "type": "map", - "key": { - "shape": "FederationAttributeKey" - }, - "value": { - "shape": "url" - } + "documentation": "Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
" }, - "CreateEnvironmentRequest": { - "type": "structure", - "required": [ - "name" - ], - "members": { - "name": { - "shape": "EnvironmentName", - "documentation": "The name of the FinSpace environment to be created.
" - }, - "description": { - "shape": "Description", - "documentation": "The description of the FinSpace environment to be created.
" - }, - "kmsKeyId": { - "shape": "KmsKeyId", - "documentation": "The KMS key id to encrypt your data in the FinSpace environment.
" - }, - "tags": { - "shape": "TagMap", - "documentation": "Add tags to your FinSpace environment.
" + "DeleteKxUser": { + "name": "DeleteKxUser", + "http": { + "method": "DELETE", + "requestUri": "/kx/environments/{environmentId}/users/{userName}" + }, + "input": { + "shape": "DeleteKxUserRequest" + }, + "output": { + "shape": "DeleteKxUserResponse" + }, + "errors": [ + { + "shape": "InternalServerException" }, - "federationMode": { - "shape": "FederationMode", - "documentation": "Authentication mode for the environment.
FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL
- Users access FinSpace via email and password managed within the FinSpace environment.
Configuration information when authentication mode is FEDERATED.
" + { + "shape": "AccessDeniedException" }, - "superuserParameters": { - "shape": "SuperuserParameters", - "documentation": "Configuration information for the superuser.
" + { + "shape": "ResourceNotFoundException" }, - "dataBundles": { - "shape": "DataBundleArns", - "documentation": "The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
arn:aws:finspace:${Region}::data-bundle/capital-markets-sample
- Contains sample Capital Markets datasets, categories and controlled vocabularies.
arn:aws:finspace:${Region}::data-bundle/taq
(default) - Contains trades and quotes data in addition to sample Capital Markets data.
Deletes a user in the specified kdb environment.
" }, - "CreateEnvironmentResponse": { - "type": "structure", + "GetEnvironment": { + "name": "GetEnvironment", + "http": { + "method": "GET", + "requestUri": "/environment/{environmentId}" + }, + "input": { + "shape": "GetEnvironmentRequest" + }, + "output": { + "shape": "GetEnvironmentResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "documentation": "Returns the FinSpace environment object.
" + }, + "GetKxChangeset": { + "name": "GetKxChangeset", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}" + }, + "input": { + "shape": "GetKxChangesetRequest" + }, + "output": { + "shape": "GetKxChangesetResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Returns information about a kdb changeset.
" + }, + "GetKxCluster": { + "name": "GetKxCluster", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}" + }, + "input": { + "shape": "GetKxClusterRequest" + }, + "output": { + "shape": "GetKxClusterResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Retrieves information about a kdb cluster.
" + }, + "GetKxConnectionString": { + "name": "GetKxConnectionString", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/connectionString" + }, + "input": { + "shape": "GetKxConnectionStringRequest" + }, + "output": { + "shape": "GetKxConnectionStringResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
" + }, + "GetKxDatabase": { + "name": "GetKxDatabase", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}" + }, + "input": { + "shape": "GetKxDatabaseRequest" + }, + "output": { + "shape": "GetKxDatabaseResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Returns database information for the specified environment ID.
" + }, + "GetKxEnvironment": { + "name": "GetKxEnvironment", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}" + }, + "input": { + "shape": "GetKxEnvironmentRequest" + }, + "output": { + "shape": "GetKxEnvironmentResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "documentation": "Retrieves all the information for the specified kdb environment.
" + }, + "GetKxUser": { + "name": "GetKxUser", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/users/{userName}" + }, + "input": { + "shape": "GetKxUserRequest" + }, + "output": { + "shape": "GetKxUserResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves information about the specified kdb user.
" + }, + "ListEnvironments": { + "name": "ListEnvironments", + "http": { + "method": "GET", + "requestUri": "/environment" + }, + "input": { + "shape": "ListEnvironmentsRequest" + }, + "output": { + "shape": "ListEnvironmentsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "A list of all of your FinSpace environments.
" + }, + "ListKxChangesets": { + "name": "ListKxChangesets", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets" + }, + "input": { + "shape": "ListKxChangesetsRequest" + }, + "output": { + "shape": "ListKxChangesetsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Returns a list of all the changesets for a database.
" + }, + "ListKxClusterNodes": { + "name": "ListKxClusterNodes", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes" + }, + "input": { + "shape": "ListKxClusterNodesRequest" + }, + "output": { + "shape": "ListKxClusterNodesResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Lists all the nodes in a kdb cluster.
" + }, + "ListKxClusters": { + "name": "ListKxClusters", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/clusters" + }, + "input": { + "shape": "ListKxClustersRequest" + }, + "output": { + "shape": "ListKxClustersResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Returns a list of clusters.
" + }, + "ListKxDatabases": { + "name": "ListKxDatabases", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/databases" + }, + "input": { + "shape": "ListKxDatabasesRequest" + }, + "output": { + "shape": "ListKxDatabasesResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Returns a list of all the databases in the kdb environment.
" + }, + "ListKxEnvironments": { + "name": "ListKxEnvironments", + "http": { + "method": "GET", + "requestUri": "/kx/environments" + }, + "input": { + "shape": "ListKxEnvironmentsRequest" + }, + "output": { + "shape": "ListKxEnvironmentsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Returns a list of kdb environments created in an account.
" + }, + "ListKxUsers": { + "name": "ListKxUsers", + "http": { + "method": "GET", + "requestUri": "/kx/environments/{environmentId}/users" + }, + "input": { + "shape": "ListKxUsersRequest" + }, + "output": { + "shape": "ListKxUsersResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists all the users in a kdb environment.
" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "A list of all tags for a resource.
" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Adds metadata tags to a FinSpace resource.
" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Removes metadata tags from a FinSpace resource.
" + }, + "UpdateEnvironment": { + "name": "UpdateEnvironment", + "http": { + "method": "PUT", + "requestUri": "/environment/{environmentId}" + }, + "input": { + "shape": "UpdateEnvironmentRequest" + }, + "output": { + "shape": "UpdateEnvironmentResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Update your FinSpace environment.
" + }, + "UpdateKxClusterDatabases": { + "name": "UpdateKxClusterDatabases", + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases" + }, + "input": { + "shape": "UpdateKxClusterDatabasesRequest" + }, + "output": { + "shape": "UpdateKxClusterDatabasesResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Updates the databases mounted on a kdb cluster, which includes the changesetId
and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
" + }, + "UpdateKxDatabase": { + "name": "UpdateKxDatabase", + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/databases/{databaseName}" + }, + "input": { + "shape": "UpdateKxDatabaseRequest" + }, + "output": { + "shape": "UpdateKxDatabaseResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Updates information for the given kdb database.
" + }, + "UpdateKxEnvironment": { + "name": "UpdateKxEnvironment", + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}" + }, + "input": { + "shape": "UpdateKxEnvironmentRequest" + }, + "output": { + "shape": "UpdateKxEnvironmentResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Updates information for the given kdb environment.
" + }, + "UpdateKxEnvironmentNetwork": { + "name": "UpdateKxEnvironmentNetwork", + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/network" + }, + "input": { + "shape": "UpdateKxEnvironmentNetworkRequest" + }, + "output": { + "shape": "UpdateKxEnvironmentNetworkResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.
Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
" + }, + "UpdateKxUser": { + "name": "UpdateKxUser", + "http": { + "method": "PUT", + "requestUri": "/kx/environments/{environmentId}/users/{userName}" + }, + "input": { + "shape": "UpdateKxUserRequest" + }, + "output": { + "shape": "UpdateKxUserResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Updates the user details. You can only update the IAM role associated with a user.
" + } + }, + "shapes": { + "AttributeMap": { + "type": "map", + "key": { + "shape": "FederationAttributeKey" + }, + "value": { + "shape": "FederationAttributeValue" + } + }, + "AutoScalingConfiguration": { + "type": "structure", + "members": { + "minNodeCount": { + "shape": "NodeCount", + "documentation": "The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount
. If the nodes in a cluster belong to multiple availability zones, then minNodeCount
must be at least 3.
The highest number of nodes to scale. This value cannot be greater than 5.
" + }, + "autoScalingMetric": { + "shape": "AutoScalingMetric", + "documentation": " The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE
is the average CPU usage across all the nodes in a cluster.
The desired value of the chosen autoScalingMetric
. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
" + }, + "scaleOutCooldownSeconds": { + "shape": "CooldownTime", + "documentation": "The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
" + } + }, + "documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + }, + "AutoScalingMetric": { + "type": "string", + "enum": [ + "CPU_UTILIZATION_PERCENTAGE" + ] + }, + "AutoScalingMetricTarget": { + "type": "double", + "max": 100, + "min": 1 + }, + "AvailabilityZoneId": { + "type": "string" + }, + "AvailabilityZoneIds": { + "type": "list", + "member": { + "shape": "AvailabilityZoneId" + } + }, + "BoxedInteger": { + "type": "integer", + "box": true + }, + "CapacityConfiguration": { + "type": "structure", + "members": { + "nodeType": { + "shape": "NodeType", + "documentation": "The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.
You can only specify one of the following values:
kx.s.large
– The node type with a configuration of 12 GiB memory and 2 vCPUs.
kx.s.xlarge
– The node type with a configuration of 27 GiB memory and 4 vCPUs.
kx.s.2xlarge
– The node type with a configuration of 54 GiB memory and 8 vCPUs.
kx.s.4xlarge
– The node type with a configuration of 108 GiB memory and 16 vCPUs.
kx.s.8xlarge
– The node type with a configuration of 216 GiB memory and 32 vCPUs.
kx.s.16xlarge
– The node type with a configuration of 432 GiB memory and 64 vCPUs.
kx.s.32xlarge
– The node type with a configuration of 864 GiB memory and 128 vCPUs.
The number of instances running in a cluster.
" + } + }, + "documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
" + }, + "ChangeRequest": { + "type": "structure", + "required": [ + "changeType", + "dbPath" + ], + "members": { + "changeType": { + "shape": "ChangeType", + "documentation": "Defines the type of change request. A changeType
can have the following values:
PUT – Adds or updates files in a database.
DELETE – Deletes files in a database.
Defines the S3 path of the source file that is required to add or update files in a database.
" + }, + "dbPath": { + "shape": "DbPath", + "documentation": "Defines the path within the database directory.
" + } + }, + "documentation": "A list of change request objects.
" + }, + "ChangeRequests": { + "type": "list", + "member": { + "shape": "ChangeRequest" + }, + "max": 32, + "min": 1 + }, + "ChangeType": { + "type": "string", + "enum": [ + "PUT", + "DELETE" + ] + }, + "ChangesetId": { + "type": "string", + "max": 26, + "min": 1 + }, + "ChangesetStatus": { + "type": "string", + "enum": [ + "PENDING", + "PROCESSING", + "FAILED", + "COMPLETED" + ] + }, + "ClientToken": { + "type": "string", + "max": 36, + "min": 1, + "pattern": ".*\\S.*" + }, + "ClientTokenString": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[a-zA-Z0-9-]+$" + }, + "CodeConfiguration": { + "type": "structure", + "members": { + "s3Bucket": { + "shape": "S3Bucket", + "documentation": "A unique name for the S3 bucket.
" + }, + "s3Key": { + "shape": "S3Key", + "documentation": "The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.
" + }, + "s3ObjectVersion": { + "shape": "S3ObjectVersion", + "documentation": "The version of an S3 object.
" + } + }, + "documentation": "The structure of the customer code available within the running cluster.
" + }, + "CooldownTime": { + "type": "double", + "max": 100000, + "min": 0 + }, + "CreateEnvironmentRequest": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "shape": "EnvironmentName", + "documentation": "The name of the FinSpace environment to be created.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the FinSpace environment to be created.
" + }, + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The KMS key id to encrypt your data in the FinSpace environment.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "Add tags to your FinSpace environment.
" + }, + "federationMode": { + "shape": "FederationMode", + "documentation": "Authentication mode for the environment.
FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL
- Users access FinSpace via email and password managed within the FinSpace environment.
Configuration information when authentication mode is FEDERATED.
" + }, + "superuserParameters": { + "shape": "SuperuserParameters", + "documentation": "Configuration information for the superuser.
" + }, + "dataBundles": { + "shape": "DataBundleArns", + "documentation": "The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
arn:aws:finspace:${Region}::data-bundle/capital-markets-sample
- Contains sample Capital Markets datasets, categories and controlled vocabularies.
arn:aws:finspace:${Region}::data-bundle/taq
(default) - Contains trades and quotes data in addition to sample Capital Markets data.
The unique identifier for FinSpace environment that you created.
" + }, + "environmentArn": { + "shape": "EnvironmentArn", + "documentation": "The Amazon Resource Name (ARN) of the FinSpace environment that you created.
" + }, + "environmentUrl": { + "shape": "url", + "documentation": "The sign-in URL for the web application of the FinSpace environment you created.
" + } + } + }, + "CreateKxChangesetRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "changeRequests", + "clientToken" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier of the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
", + "location": "uri", + "locationName": "databaseName" + }, + "changeRequests": { + "shape": "ChangeRequests", + "documentation": "A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:
PUT – Adds or updates files in a database.
DELETE – Deletes files in a database.
All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.
Here is an example of how you can use the change request object:
[ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\", \"dbPath\":\"/2020.01.02/\"}, { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\", \"dbPath\":\"/\"}, { \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.01/\"} ]
In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.
" + }, + "clientToken": { + "shape": "ClientTokenString", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "idempotencyToken": true + } + } + }, + "CreateKxChangesetResponse": { + "type": "structure", + "members": { + "changesetId": { + "shape": "ChangesetId", + "documentation": "A unique identifier for the changeset.
" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
" + }, + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
" + }, + "changeRequests": { + "shape": "ChangeRequests", + "documentation": "A list of change requests.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "status": { + "shape": "ChangesetStatus", + "documentation": "Status of the changeset creation process.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
" + } + } + }, + "CreateKxClusterRequest": { + "type": "structure", + "required": [ + "environmentId", + "clusterName", + "clusterType", + "capacityConfiguration", + "releaseLabel", + "azMode" + ], + "members": { + "clientToken": { + "shape": "ClientToken", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "idempotencyToken": true + }, + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A unique name for the cluster that you want to create.
" + }, + "clusterType": { + "shape": "KxClusterType", + "documentation": "Specifies the type of KDB database that is being created. The following types are available:
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration
parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
A list of databases that will be available for querying.
" + }, + "cacheStorageConfigurations": { + "shape": "KxCacheStorageConfigurations", + "documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" + }, + "autoScalingConfiguration": { + "shape": "AutoScalingConfiguration", + "documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + }, + "clusterDescription": { + "shape": "KxClusterDescription", + "documentation": "A description of the cluster.
" + }, + "capacityConfiguration": { + "shape": "CapacityConfiguration", + "documentation": "A structure for the metadata of a cluster. It includes information about like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
" + }, + "releaseLabel": { + "shape": "ReleaseLabel", + "documentation": "The version of FinSpace managed kdb to run.
" + }, + "vpcConfiguration": { + "shape": "VpcConfiguration", + "documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" + }, + "initializationScript": { + "shape": "InitializationScriptFilePath", + "documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q
.
Defines the key-value pairs to make them available inside the cluster.
" + }, + "code": { + "shape": "CodeConfiguration", + "documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" + }, + "executionRole": { + "shape": "ExecutionRoleArn", + "documentation": "An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
" + }, + "savedownStorageConfiguration": { + "shape": "KxSavedownStorageConfiguration", + "documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE
– Assigns one availability zone per cluster.
MULTI
– Assigns all the availability zones per cluster.
The availability zone identifiers for the requested regions.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
" + } + } + }, + "CreateKxClusterResponse": { + "type": "structure", + "members": { + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "A unique identifier for the kdb environment.
" + }, + "status": { + "shape": "KxClusterStatus", + "documentation": "The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The error message when a failed state occurs.
" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A unique name for the cluster.
" + }, + "clusterType": { + "shape": "KxClusterType", + "documentation": "Specifies the type of KDB database that is being created. The following types are available:
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration
parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
A list of databases that will be available for querying.
" + }, + "cacheStorageConfigurations": { + "shape": "KxCacheStorageConfigurations", + "documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" + }, + "autoScalingConfiguration": { + "shape": "AutoScalingConfiguration", + "documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + }, + "clusterDescription": { + "shape": "KxClusterDescription", + "documentation": "A description of the cluster.
" + }, + "capacityConfiguration": { + "shape": "CapacityConfiguration", + "documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
" + }, + "releaseLabel": { + "shape": "ReleaseLabel", + "documentation": "A version of the FinSpace managed kdb to run.
" + }, + "vpcConfiguration": { + "shape": "VpcConfiguration", + "documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" + }, + "initializationScript": { + "shape": "InitializationScriptFilePath", + "documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q
.
Defines the key-value pairs to make them available inside the cluster.
" + }, + "code": { + "shape": "CodeConfiguration", + "documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" + }, + "executionRole": { + "shape": "ExecutionRoleArn", + "documentation": "An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "savedownStorageConfiguration": { + "shape": "KxSavedownStorageConfiguration", + "documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE
– Assigns one availability zone per cluster.
MULTI
– Assigns all the availability zones per cluster.
The availability zone identifiers for the requested regions.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "CreateKxDatabaseRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "clientToken" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
" + }, + "description": { + "shape": "Description", + "documentation": "A description of the database.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
" + }, + "clientToken": { + "shape": "ClientTokenString", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "idempotencyToken": true + } + } + }, + "CreateKxDatabaseResponse": { + "type": "structure", + "members": { + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
" + }, + "databaseArn": { + "shape": "DatabaseArn", + "documentation": "The ARN identifier of the database.
" + }, + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
" + }, + "description": { + "shape": "Description", + "documentation": "A description of the database.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "CreateKxEnvironmentRequest": { + "type": "structure", + "required": [ + "name", + "kmsKeyId" + ], + "members": { + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment that you want to create.
" + }, + "description": { + "shape": "Description", + "documentation": "A description for the kdb environment.
" + }, + "kmsKeyId": { + "shape": "KmsKeyARN", + "documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
" + } + } + }, + "CreateKxEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment.
" + }, + "status": { + "shape": "EnvironmentStatus", + "documentation": "The status of the kdb environment.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "description": { + "shape": "Description", + "documentation": "A description for the kdb environment.
" + }, + "environmentArn": { + "shape": "EnvironmentArn", + "documentation": "The ARN identifier of the environment.
" + }, + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + }, + "creationTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + } + } + }, + "CreateKxUserRequest": { + "type": "structure", + "required": [ + "environmentId", + "userName", + "iamRole" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment where you want to create a user.
", + "location": "uri", + "locationName": "environmentId" + }, + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user.
" + }, + "iamRole": { + "shape": "RoleArn", + "documentation": "The IAM role ARN that will be associated with the user.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "A list of key-value pairs to label the user. You can add up to 50 tags to a user.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
" + } + } + }, + "CreateKxUserResponse": { + "type": "structure", + "members": { + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user.
" + }, + "userArn": { + "shape": "KxUserArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "iamRole": { + "shape": "RoleArn", + "documentation": "The IAM role ARN that will be associated with the user.
" + } + } + }, + "CustomDNSConfiguration": { + "type": "list", + "member": { + "shape": "CustomDNSServer" + } + }, + "CustomDNSServer": { + "type": "structure", + "required": [ + "customDNSServerName", + "customDNSServerIP" + ], + "members": { + "customDNSServerName": { + "shape": "ValidHostname", + "documentation": "The name of the DNS server.
" + }, + "customDNSServerIP": { + "shape": "ValidIPAddress", + "documentation": "The IP address of the DNS server.
" + } + }, + "documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + }, + "DataBundleArn": { + "type": "string", + "documentation": "The Amazon Resource Name (ARN) of the data bundle.
", + "max": 2048, + "min": 20, + "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$" + }, + "DataBundleArns": { + "type": "list", + "member": { + "shape": "DataBundleArn" + } + }, + "DatabaseArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string", + "max": 63, + "min": 3, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + "DbPath": { + "type": "string", + "max": 1025, + "min": 1, + "pattern": "^\\/([^\\/]+\\/){0,2}[^\\/]*$" + }, + "DbPaths": { + "type": "list", + "member": { + "shape": "DbPath" + } + }, + "DeleteEnvironmentRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "The identifier for the FinSpace environment.
", + "location": "uri", + "locationName": "environmentId" + } + } + }, + "DeleteEnvironmentResponse": { + "type": "structure", + "members": {} + }, + "DeleteKxClusterRequest": { + "type": "structure", + "required": [ + "environmentId", + "clusterName" + ], + "members": { + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "The name of the cluster that you want to delete.
", + "location": "uri", + "locationName": "clusterName" + }, + "clientToken": { + "shape": "ClientTokenString", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + } + } + }, + "DeleteKxClusterResponse": { + "type": "structure", + "members": {} + }, + "DeleteKxDatabaseRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "clientToken" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database that you want to delete.
", + "location": "uri", + "locationName": "databaseName" + }, + "clientToken": { + "shape": "ClientTokenString", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + } + } + }, + "DeleteKxDatabaseResponse": { + "type": "structure", + "members": {} + }, + "DeleteKxEnvironmentRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + } + } + }, + "DeleteKxEnvironmentResponse": { + "type": "structure", + "members": {} + }, + "DeleteKxUserRequest": { + "type": "structure", + "required": [ + "userName", + "environmentId" + ], + "members": { + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user that you want to delete.
", + "location": "uri", + "locationName": "userName" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + } + } + }, + "DeleteKxUserResponse": { + "type": "structure", + "members": {} + }, + "Description": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "^[a-zA-Z0-9. ]{1,1000}$" + }, + "EmailId": { + "type": "string", + "max": 128, + "min": 1, + "pattern": "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+", + "sensitive": true + }, + "Environment": { + "type": "structure", + "members": { + "name": { + "shape": "EnvironmentName", + "documentation": "The name of the FinSpace environment.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "The identifier of the FinSpace environment.
" + }, + "awsAccountId": { + "shape": "IdType", + "documentation": "The ID of the AWS account in which the FinSpace environment is created.
" + }, + "status": { + "shape": "EnvironmentStatus", + "documentation": "The current status of creation of the FinSpace environment.
" + }, + "environmentUrl": { + "shape": "url", + "documentation": "The sign-in URL for the web application of your FinSpace environment.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the FinSpace environment.
" + }, + "environmentArn": { + "shape": "EnvironmentArn", + "documentation": "The Amazon Resource Name (ARN) of your FinSpace environment.
" + }, + "sageMakerStudioDomainUrl": { + "shape": "SmsDomainUrl", + "documentation": "The URL of the integrated FinSpace notebook environment in your web application.
" + }, + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The KMS key id used to encrypt in the FinSpace environment.
" + }, + "dedicatedServiceAccountId": { + "shape": "IdType", + "documentation": "The AWS account ID of the dedicated service account associated with your FinSpace environment.
" + }, + "federationMode": { + "shape": "FederationMode", + "documentation": "The authentication mode for the environment.
" + }, + "federationParameters": { + "shape": "FederationParameters", + "documentation": "Configuration information when authentication mode is FEDERATED.
" + } + }, + "documentation": "Represents an FinSpace environment.
" + }, + "EnvironmentArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$" + }, + "EnvironmentErrorMessage": { + "type": "string", + "max": 1000, + "min": 0, + "pattern": "^[a-zA-Z0-9. ]{1,1000}$" + }, + "EnvironmentId": { + "type": "string", + "max": 32, + "min": 1, + "pattern": ".*\\S.*" + }, + "EnvironmentList": { + "type": "list", + "member": { + "shape": "Environment" + } + }, + "EnvironmentName": { + "type": "string", + "max": 255, + "min": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$" + }, + "EnvironmentStatus": { + "type": "string", + "enum": [ + "CREATE_REQUESTED", + "CREATING", + "CREATED", + "DELETE_REQUESTED", + "DELETING", + "DELETED", + "FAILED_CREATION", + "RETRY_DELETION", + "FAILED_DELETION", + "UPDATE_NETWORK_REQUESTED", + "UPDATING_NETWORK", + "FAILED_UPDATING_NETWORK", + "SUSPENDED" + ] + }, + "ErrorDetails": { + "type": "string", + "enum": [ + "The inputs to this request are invalid.", + "Service limits have been exceeded.", + "Missing required permission to perform this request.", + "One or more inputs to this request were not found.", + "The system temporarily lacks sufficient resources to process the request.", + "An internal error has occurred.", + "Cancelled", + "A user recoverable error has occurred" + ] + }, + "ErrorInfo": { + "type": "structure", + "members": { + "errorMessage": { + "shape": "ErrorMessage", + "documentation": "Specifies the error message that appears if a flow fails.
" + }, + "errorType": { + "shape": "ErrorDetails", + "documentation": "Specifies the type of error.
" + } + }, + "documentation": "Provides details in the event of a failed flow, including the error type and the related error message.
" + }, + "ErrorMessage": { + "type": "string", + "max": 1000 + }, + "ExecutionRoleArn": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "^arn:aws[a-z0-9-]*:iam::\\d{12}:role\\/[\\w-\\/.@+=,]{1,1017}$" + }, + "FederationAttributeKey": { + "type": "string", + "max": 32, + "min": 1, + "pattern": ".*" + }, + "FederationAttributeValue": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": ".*" + }, + "FederationMode": { + "type": "string", + "enum": [ + "FEDERATED", + "LOCAL" + ] + }, + "FederationParameters": { + "type": "structure", + "members": { + "samlMetadataDocument": { + "shape": "SamlMetadataDocument", + "documentation": "SAML 2.0 Metadata document from identity provider (IdP).
" + }, + "samlMetadataURL": { + "shape": "url", + "documentation": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
" + }, + "applicationCallBackURL": { + "shape": "url", + "documentation": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
" + }, + "federationURN": { + "shape": "urn", + "documentation": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
" + }, + "federationProviderName": { + "shape": "FederationProviderName", + "documentation": "Name of the identity provider (IdP).
" + }, + "attributeMap": { + "shape": "AttributeMap", + "documentation": "SAML attribute name and value. The name must always be Email
and the value should be set to the attribute definition in which user email is set. For example, name would be Email
and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
Configuration information when authentication mode is FEDERATED.
" + }, + "FederationProviderName": { + "type": "string", + "max": 32, + "min": 1, + "pattern": "[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+" + }, + "FinSpaceTaggableArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:(environment|kxEnvironment)/[0-9A-Za-z_-]{1,128}(/(kxDatabase|kxCluster|kxUser)/[a-zA-Z0-9_-]{1,255})?$" + }, + "GetEnvironmentRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "The identifier of the FinSpace environment.
", + "location": "uri", + "locationName": "environmentId" + } + } + }, + "GetEnvironmentResponse": { + "type": "structure", + "members": { + "environment": { + "shape": "Environment", + "documentation": "The name of the FinSpace environment.
" + } + } + }, + "GetKxChangesetRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "changesetId" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
", + "location": "uri", + "locationName": "databaseName" + }, + "changesetId": { + "shape": "ChangesetId", + "documentation": "A unique identifier of the changeset for which you want to retrieve data.
", + "location": "uri", + "locationName": "changesetId" + } + } + }, + "GetKxChangesetResponse": { + "type": "structure", + "members": { + "changesetId": { + "shape": "ChangesetId", + "documentation": "A unique identifier for the changeset.
" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
" + }, + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
" + }, + "changeRequests": { + "shape": "ChangeRequests", + "documentation": "A list of change request objects that are run in order.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "activeFromTimestamp": { + "shape": "Timestamp", + "documentation": "Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "status": { + "shape": "ChangesetStatus", + "documentation": "Status of the changeset creation process.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
Provides details in the event of a failed flow, including the error type and the related error message.
" + } + } + }, + "GetKxClusterRequest": { + "type": "structure", + "required": [ + "environmentId", + "clusterName" + ], + "members": { + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "The name of the cluster that you want to retrieve.
", + "location": "uri", + "locationName": "clusterName" + } + } + }, + "GetKxClusterResponse": { + "type": "structure", + "members": { + "status": { + "shape": "KxClusterStatus", + "documentation": "The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The error message when a failed state occurs.
" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A unique name for the cluster.
" + }, + "clusterType": { + "shape": "KxClusterType", + "documentation": "Specifies the type of KDB database that is being created. The following types are available:
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration
parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
A list of databases mounted on the cluster.
" + }, + "cacheStorageConfigurations": { + "shape": "KxCacheStorageConfigurations", + "documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" + }, + "autoScalingConfiguration": { + "shape": "AutoScalingConfiguration", + "documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + }, + "clusterDescription": { + "shape": "KxClusterDescription", + "documentation": "A description of the cluster.
" + }, + "capacityConfiguration": { + "shape": "CapacityConfiguration", + "documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
" + }, + "releaseLabel": { + "shape": "ReleaseLabel", + "documentation": "The version of FinSpace managed kdb to run.
" + }, + "vpcConfiguration": { + "shape": "VpcConfiguration", + "documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" + }, + "initializationScript": { + "shape": "InitializationScriptFilePath", + "documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q
.
Defines key-value pairs to make them available inside the cluster.
" + }, + "code": { + "shape": "CodeConfiguration", + "documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" + }, + "executionRole": { + "shape": "ExecutionRoleArn", + "documentation": "An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "savedownStorageConfiguration": { + "shape": "KxSavedownStorageConfiguration", + "documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE
– Assigns one availability zone per cluster.
MULTI
– Assigns all the availability zones per cluster.
The availability zone identifiers for the requested regions.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "GetKxConnectionStringRequest": { + "type": "structure", + "required": [ + "userArn", + "environmentId", + "clusterName" + ], + "members": { + "userArn": { + "shape": "KxUserArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
", + "location": "querystring", + "locationName": "userArn" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A name of the kdb cluster.
", + "location": "querystring", + "locationName": "clusterName" + } + } + }, + "GetKxConnectionStringResponse": { + "type": "structure", + "members": { + "signedConnectionString": { + "shape": "SignedKxConnectionString", + "documentation": "The signed connection string that you can use to connect to clusters.
" + } + } + }, + "GetKxDatabaseRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
", + "location": "uri", + "locationName": "databaseName" + } + } + }, + "GetKxDatabaseResponse": { + "type": "structure", + "members": { + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database for which the information is retrieved.
" + }, + "databaseArn": { + "shape": "DatabaseArn", + "documentation": "The ARN identifier of the database.
" + }, + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
" + }, + "description": { + "shape": "Description", + "documentation": "A description of the database.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastCompletedChangesetId": { + "shape": "ChangesetId", + "documentation": "A unique identifier for the changeset.
" + }, + "numBytes": { + "shape": "numBytes", + "documentation": "The total number of bytes in the database.
" + }, + "numChangesets": { + "shape": "numChangesets", + "documentation": "The total number of changesets in the database.
" + }, + "numFiles": { + "shape": "numFiles", + "documentation": "The total number of files in the database.
" + } + } + }, + "GetKxEnvironmentRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + } + } + }, + "GetKxEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "awsAccountId": { + "shape": "IdType", + "documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" + }, + "status": { + "shape": "EnvironmentStatus", + "documentation": "The status of the kdb environment.
" + }, + "tgwStatus": { + "shape": "tgwStatus", + "documentation": "The status of the network configuration.
" + }, + "dnsStatus": { + "shape": "dnsStatus", + "documentation": "The status of DNS configuration.
" + }, + "errorMessage": { + "shape": "EnvironmentErrorMessage", + "documentation": "Specifies the error message that appears if a flow fails.
" + }, + "description": { + "shape": "Description", + "documentation": "A description for the kdb environment.
" + }, + "environmentArn": { + "shape": "EnvironmentArn", + "documentation": "The ARN identifier of the environment.
" + }, + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + }, + "dedicatedServiceAccountId": { + "shape": "IdType", + "documentation": "A unique identifier for the AWS environment infrastructure account.
" + }, + "transitGatewayConfiguration": { + "shape": "TransitGatewayConfiguration" + }, + "customDNSConfiguration": { + "shape": "CustomDNSConfiguration", + "documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + }, + "creationTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + }, + "updateTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was updated.
" + }, + "availabilityZoneIds": { + "shape": "AvailabilityZoneIds", + "documentation": "The identifier of the availability zones where subnets for the environment are created.
" + }, + "certificateAuthorityArn": { + "shape": "stringValueLength1to255", + "documentation": "The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
" + } + } + }, + "GetKxUserRequest": { + "type": "structure", + "required": [ + "userName", + "environmentId" + ], + "members": { + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user.
", + "location": "uri", + "locationName": "userName" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + } + } + }, + "GetKxUserResponse": { + "type": "structure", + "members": { + "userName": { + "shape": "IdType", + "documentation": "A unique identifier for the user.
" + }, + "userArn": { + "shape": "KxUserArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "iamRole": { + "shape": "RoleArn", + "documentation": "The IAM role ARN that is associated with the user.
" + } + } + }, + "IPAddressType": { + "type": "string", + "enum": [ + "IP_V4" + ] + }, + "IdType": { + "type": "string", + "max": 26, + "min": 1, + "pattern": "^[a-zA-Z0-9]{1,26}$" + }, + "InitializationScriptFilePath": { + "type": "string", + "max": 255, + "min": 1, + "pattern": "^[a-zA-Z0-9\\_\\-\\.\\/\\\\]+$" + }, + "KmsKeyARN": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "^arn:aws:kms:.*:\\d+:.*$" + }, + "KmsKeyId": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "^[a-zA-Z-0-9-:\\/]*$" + }, + "KxAzMode": { + "type": "string", + "enum": [ + "SINGLE", + "MULTI" + ] + }, + "KxCacheStorageConfiguration": { + "type": "structure", + "required": [ + "type", + "size" + ], + "members": { + "type": { + "shape": "KxCacheStorageType", + "documentation": "The type of cache storage . The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
The size of cache in Gigabytes.
" + } + }, + "documentation": "The configuration for read only disk cache associated with a cluster.
" + }, + "KxCacheStorageConfigurations": { + "type": "list", + "member": { + "shape": "KxCacheStorageConfiguration" + } + }, + "KxCacheStorageSize": { + "type": "integer", + "max": 33600, + "min": 1200 + }, + "KxCacheStorageType": { + "type": "string", + "max": 10, + "min": 8 + }, + "KxChangesetListEntry": { + "type": "structure", + "members": { + "changesetId": { + "shape": "ChangesetId", + "documentation": "A unique identifier for the changeset.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "activeFromTimestamp": { + "shape": "Timestamp", + "documentation": "Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the changeset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "status": { + "shape": "ChangesetStatus", + "documentation": "Status of the changeset.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
Details of changeset.
" + }, + "KxChangesets": { + "type": "list", + "member": { + "shape": "KxChangesetListEntry" + } + }, + "KxCluster": { + "type": "structure", + "members": { + "status": { + "shape": "KxClusterStatus", + "documentation": "The status of a cluster.
PENDING – The cluster is pending creation.
CREATING –The cluster creation process is in progress.
CREATE_FAILED– The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The error message when a failed state occurs.
" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A unique name for the cluster.
" + }, + "clusterType": { + "shape": "KxClusterType", + "documentation": "Specifies the type of KDB database that is being created. The following types are available:
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration
parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
A description of the cluster.
" + }, + "releaseLabel": { + "shape": "ReleaseLabel", + "documentation": "A version of the FinSpace managed kdb to run.
" + }, + "initializationScript": { + "shape": "InitializationScriptFilePath", + "documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q
.
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
" + }, + "azMode": { + "shape": "KxAzMode", + "documentation": "The number of availability zones assigned per cluster. This can be one of the following
SINGLE
– Assigns one availability zone per cluster.
MULTI
– Assigns all the availability zones per cluster.
The availability zone identifiers for the requested regions.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "documentation": "The details of a kdb cluster.
" + }, + "KxClusterDescription": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" + }, + "KxClusterName": { + "type": "string", + "max": 63, + "min": 3, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + "KxClusterNodeIdString": { + "type": "string", + "max": 40, + "min": 1 + }, + "KxClusterStatus": { + "type": "string", + "enum": [ + "PENDING", + "CREATING", + "CREATE_FAILED", + "RUNNING", + "UPDATING", + "DELETING", + "DELETED", + "DELETE_FAILED" + ] + }, + "KxClusterStatusReason": { + "type": "string", + "max": 250, + "min": 1, + "pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" + }, + "KxClusterType": { + "type": "string", + "enum": [ + "HDB", + "RDB", + "GATEWAY" + ] + }, + "KxClusters": { + "type": "list", + "member": { + "shape": "KxCluster" + } + }, + "KxCommandLineArgument": { + "type": "structure", + "members": { + "key": { + "shape": "KxCommandLineArgumentKey", + "documentation": "The name of the key.
" + }, + "value": { + "shape": "KxCommandLineArgumentValue", + "documentation": "The value of the key.
" + } + }, + "documentation": "Defines the key-value pairs to make them available inside the cluster.
" + }, + "KxCommandLineArgumentKey": { + "type": "string", + "max": 50, + "min": 1, + "pattern": "^(?![Aa][Ww][Ss])(s|([a-zA-Z][a-zA-Z0-9_]+))" + }, + "KxCommandLineArgumentValue": { + "type": "string", + "max": 50, + "min": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_:.]*" + }, + "KxCommandLineArguments": { + "type": "list", + "member": { + "shape": "KxCommandLineArgument" + } + }, + "KxDatabaseCacheConfiguration": { + "type": "structure", + "required": [ + "cacheType", + "dbPaths" + ], + "members": { + "cacheType": { + "shape": "KxCacheStorageType", + "documentation": "The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
Specifies the portions of database that will be loaded into the cache for access.
" + } + }, + "documentation": "The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
" + }, + "KxDatabaseCacheConfigurations": { + "type": "list", + "member": { + "shape": "KxDatabaseCacheConfiguration" + } + }, + "KxDatabaseConfiguration": { + "type": "structure", + "required": [ + "databaseName" + ], + "members": { + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
" + }, + "cacheConfigurations": { + "shape": "KxDatabaseCacheConfigurations", + "documentation": "Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
" + }, + "changesetId": { + "shape": "ChangesetId", + "documentation": "A unique identifier of the changeset that is associated with the cluster.
" + } + }, + "documentation": "The configuration of data that is available for querying from this database.
" + }, + "KxDatabaseConfigurations": { + "type": "list", + "member": { + "shape": "KxDatabaseConfiguration" + } + }, + "KxDatabaseListEntry": { + "type": "structure", + "members": { + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
" + }, + "createdTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the database was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "documentation": "Details about a FinSpace managed kdb database
" + }, + "KxDatabases": { + "type": "list", + "member": { + "shape": "KxDatabaseListEntry" + } + }, + "KxEnvironment": { + "type": "structure", "members": { + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment.
" + }, "environmentId": { "shape": "IdType", - "documentation": "The unique identifier for FinSpace environment that you created.
" + "documentation": "A unique identifier for the kdb environment.
" + }, + "awsAccountId": { + "shape": "IdType", + "documentation": "The unique identifier of the AWS account in which you create the kdb environment.
" + }, + "status": { + "shape": "EnvironmentStatus", + "documentation": "The status of the environment creation.
CREATE_REQUESTED – Environment creation has been requested.
CREATING – Environment is in the process of being created.
FAILED_CREATION – Environment creation has failed.
CREATED – Environment is successfully created and is currently active.
DELETE REQUESTED – Environment deletion has been requested.
DELETING – Environment is in the process of being deleted.
RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.
DELETED – Environment has been deleted.
FAILED_DELETION – Environment deletion has failed.
The status of the network configuration.
" + }, + "dnsStatus": { + "shape": "dnsStatus", + "documentation": "The status of DNS configuration.
" + }, + "errorMessage": { + "shape": "EnvironmentErrorMessage", + "documentation": "Specifies the error message that appears if a flow fails.
" + }, + "description": { + "shape": "Description", + "documentation": "A description of the kdb environment.
" }, "environmentArn": { "shape": "EnvironmentArn", - "documentation": "The Amazon Resource Name (ARN) of the FinSpace environment that you created.
" + "documentation": "The Amazon Resource Name (ARN) of your kdb environment.
" }, - "environmentUrl": { - "shape": "url", - "documentation": "The sign-in url for the web application of the FinSpace environment you created.
" + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The unique identifier of the KMS key.
" + }, + "dedicatedServiceAccountId": { + "shape": "IdType", + "documentation": "A unique identifier for the AWS environment infrastructure account.
" + }, + "transitGatewayConfiguration": { + "shape": "TransitGatewayConfiguration", + "documentation": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
" + }, + "customDNSConfiguration": { + "shape": "CustomDNSConfiguration", + "documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + }, + "creationTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "updateTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + }, + "availabilityZoneIds": { + "shape": "AvailabilityZoneIds", + "documentation": "The identifier of the availability zones where subnets for the environment are created.
" + }, + "certificateAuthorityArn": { + "shape": "stringValueLength1to255", + "documentation": "The Amazon Resource Name (ARN) of the certificate authority:
" + } + }, + "documentation": "The details of a kdb environment.
" + }, + "KxEnvironmentId": { + "type": "string", + "max": 32, + "min": 1, + "pattern": "^[a-z0-9]+$" + }, + "KxEnvironmentList": { + "type": "list", + "member": { + "shape": "KxEnvironment" + } + }, + "KxEnvironmentName": { + "type": "string", + "max": 63, + "min": 3, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + }, + "KxNode": { + "type": "structure", + "members": { + "nodeId": { + "shape": "KxClusterNodeIdString", + "documentation": "A unique identifier for the node.
" + }, + "availabilityZoneId": { + "shape": "AvailabilityZoneId", + "documentation": "The identifier of the availability zones where subnets for the environment are created.
" + }, + "launchTime": { + "shape": "Timestamp", + "documentation": "The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "documentation": "A structure that stores metadata for a kdb node.
" + }, + "KxNodeSummaries": { + "type": "list", + "member": { + "shape": "KxNode" + } + }, + "KxSavedownStorageConfiguration": { + "type": "structure", + "required": [ + "type", + "size" + ], + "members": { + "type": { + "shape": "KxSavedownStorageType", + "documentation": "The type of writeable storage space for temporarily storing your savedown data. The valid values are:
SDS01 – This type represents 3000 IOPS and io2 ebs volume type.
The size of temporary storage in bytes.
" + } + }, + "documentation": "The size and type of temporary storage that is used to hold data during the savedown process. All the data written to this storage space is lost when the cluster node is restarted.
" + }, + "KxSavedownStorageSize": { + "type": "integer", + "max": 16000, + "min": 4 + }, + "KxSavedownStorageType": { + "type": "string", + "enum": [ + "SDS01" + ] + }, + "KxUser": { + "type": "structure", + "members": { + "userArn": { + "shape": "KxUserArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
" + }, + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user.
" + }, + "iamRole": { + "shape": "RoleArn", + "documentation": "The IAM role ARN that is associated with the user.
" + }, + "createTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb user was created.
" + }, + "updateTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb user was updated.
" + } + }, + "documentation": "A structure that stores metadata for a kdb user.
" + }, + "KxUserArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}/kxUser/[0-9A-Za-z_-]{1,128}$" + }, + "KxUserList": { + "type": "list", + "member": { + "shape": "KxUser" + } + }, + "KxUserNameString": { + "type": "string", + "max": 50, + "min": 1, + "pattern": "^[0-9A-Za-z_-]{1,50}$" + }, + "ListEnvironmentsRequest": { + "type": "structure", + "members": { + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextToken
nextToken value from the response object of the previous page call.
The maximum number of results to return in this request.
", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListEnvironmentsResponse": { + "type": "structure", + "members": { + "environments": { + "shape": "EnvironmentList", + "documentation": "A list of all of your FinSpace environments.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that you can use in a subsequent call to retrieve the next set of results.
" + } + } + }, + "ListKxChangesetsRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
", + "location": "uri", + "locationName": "databaseName" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return in this request.
", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListKxChangesetsResponse": { + "type": "structure", + "members": { + "kxChangesets": { + "shape": "KxChangesets", + "documentation": "A list of changesets for a database.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "ListKxClusterNodesRequest": { + "type": "structure", + "required": [ + "clusterName", + "environmentId" + ], + "members": { + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A unique name for the cluster.
", + "location": "uri", + "locationName": "clusterName" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "ResultLimit", + "documentation": "The maximum number of results to return in this request.
", + "location": "querystring", + "locationName": "maxResults" + } + } + }, + "ListKxClusterNodesResponse": { + "type": "structure", + "members": { + "nodes": { + "shape": "KxNodeSummaries", + "documentation": "A list of nodes associated with the cluster.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "ListKxClustersRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterType": { + "shape": "KxClusterType", + "documentation": "Specifies the type of KDB database that is being created. The following types are available:
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration
parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
The maximum number of results to return in this request.
", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
", + "location": "querystring", + "locationName": "nextToken" } } }, - "DataBundleArn": { - "type": "string", - "documentation": "The Amazon Resource Name (ARN) of the data bundle.
", - "max": 2048, - "min": 20, - "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$" - }, - "DataBundleArns": { - "type": "list", - "member": { - "shape": "DataBundleArn" + "ListKxClustersResponse": { + "type": "structure", + "members": { + "kxClusterSummaries": { + "shape": "KxClusters", + "documentation": "Lists the cluster details.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
" + } } }, - "DeleteEnvironmentRequest": { + "ListKxDatabasesRequest": { "type": "structure", "required": [ "environmentId" ], "members": { "environmentId": { - "shape": "IdType", - "documentation": "The identifier for the FinSpace environment.
", + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", "location": "uri", "locationName": "environmentId" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
", + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return in this request.
", + "location": "querystring", + "locationName": "maxResults" } } }, - "DeleteEnvironmentResponse": { + "ListKxDatabasesResponse": { "type": "structure", - "members": {} - }, - "Description": { - "type": "string", - "max": 1000, - "min": 1, - "pattern": "^[a-zA-Z0-9. ]{1,1000}$" - }, - "EmailId": { - "type": "string", - "max": 128, - "min": 1, - "pattern": "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+", - "sensitive": true + "members": { + "kxDatabases": { + "shape": "KxDatabases", + "documentation": "A list of databases in the kdb environment.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
" + } + } }, - "Environment": { + "ListKxEnvironmentsRequest": { "type": "structure", "members": { - "name": { - "shape": "EnvironmentName", - "documentation": "The name of the FinSpace environment.
" - }, - "environmentId": { - "shape": "IdType", - "documentation": "The identifier of the FinSpace environment.
" - }, - "awsAccountId": { - "shape": "IdType", - "documentation": "The ID of the AWS account in which the FinSpace environment is created.
" - }, - "status": { - "shape": "EnvironmentStatus", - "documentation": "The current status of creation of the FinSpace environment.
" - }, - "environmentUrl": { - "shape": "url", - "documentation": "The sign-in url for the web application of your FinSpace environment.
" - }, - "description": { - "shape": "Description", - "documentation": "The description of the FinSpace environment.
" - }, - "environmentArn": { - "shape": "EnvironmentArn", - "documentation": "The Amazon Resource Name (ARN) of your FinSpace environment.
" - }, - "sageMakerStudioDomainUrl": { - "shape": "SmsDomainUrl", - "documentation": "The url of the integrated FinSpace notebook environment in your web application.
" - }, - "kmsKeyId": { - "shape": "KmsKeyId", - "documentation": "The KMS key id used to encrypt in the FinSpace environment.
" - }, - "dedicatedServiceAccountId": { - "shape": "IdType", - "documentation": "The AWS account ID of the dedicated service account associated with your FinSpace environment.
" - }, - "federationMode": { - "shape": "FederationMode", - "documentation": "The authentication mode for the environment.
" + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token that indicates where a results page should begin.
", + "location": "querystring", + "locationName": "nextToken" }, - "federationParameters": { - "shape": "FederationParameters", - "documentation": "Configuration information when authentication mode is FEDERATED.
" + "maxResults": { + "shape": "BoxedInteger", + "documentation": "The maximum number of results to return in this request.
", + "location": "querystring", + "locationName": "maxResults" } - }, - "documentation": "Represents an FinSpace environment.
" - }, - "EnvironmentArn": { - "type": "string", - "max": 2048, - "min": 20, - "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$" - }, - "EnvironmentList": { - "type": "list", - "member": { - "shape": "Environment" } }, - "EnvironmentName": { - "type": "string", - "max": 255, - "min": 1, - "pattern": "^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]$" - }, - "EnvironmentStatus": { - "type": "string", - "enum": [ - "CREATE_REQUESTED", - "CREATING", - "CREATED", - "DELETE_REQUESTED", - "DELETING", - "DELETED", - "FAILED_CREATION", - "RETRY_DELETION", - "FAILED_DELETION", - "SUSPENDED" - ] - }, - "FederationAttributeKey": { - "type": "string", - "max": 32, - "min": 1, - "pattern": ".*" - }, - "FederationMode": { - "type": "string", - "enum": [ - "FEDERATED", - "LOCAL" - ] - }, - "FederationParameters": { + "ListKxEnvironmentsResponse": { "type": "structure", "members": { - "samlMetadataDocument": { - "shape": "SamlMetadataDocument", - "documentation": "SAML 2.0 Metadata document from identity provider (IdP).
" - }, - "samlMetadataURL": { - "shape": "url", - "documentation": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
" - }, - "applicationCallBackURL": { - "shape": "url", - "documentation": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
" - }, - "federationURN": { - "shape": "urn", - "documentation": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
" - }, - "federationProviderName": { - "shape": "FederationProviderName", - "documentation": "Name of the identity provider (IdP).
" + "environments": { + "shape": "KxEnvironmentList", + "documentation": "A list of environments in an account.
" }, - "attributeMap": { - "shape": "AttributeMap", - "documentation": "SAML attribute name and value. The name must always be Email
and the value should be set to the attribute definition in which user email is set. For example, name would be Email
and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
A token that indicates where a results page should begin.
" } - }, - "documentation": "Configuration information when authentication mode is FEDERATED.
" - }, - "FederationProviderName": { - "type": "string", - "max": 32, - "min": 1, - "pattern": "[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+" + } }, - "GetEnvironmentRequest": { + "ListKxUsersRequest": { "type": "structure", "required": [ "environmentId" @@ -490,39 +3331,13 @@ "members": { "environmentId": { "shape": "IdType", - "documentation": "The identifier of the FinSpace environment.
", + "documentation": "A unique identifier for the kdb environment.
", "location": "uri", "locationName": "environmentId" - } - } - }, - "GetEnvironmentResponse": { - "type": "structure", - "members": { - "environment": { - "shape": "Environment", - "documentation": "The name of the FinSpace environment.
" - } - } - }, - "IdType": { - "type": "string", - "max": 26, - "min": 1, - "pattern": "^[a-zA-Z0-9]{1,26}$" - }, - "KmsKeyId": { - "type": "string", - "max": 1000, - "min": 1, - "pattern": "^[a-zA-Z-0-9-:\\/]*$" - }, - "ListEnvironmentsRequest": { - "type": "structure", - "members": { + }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextToken value from the response object of the previous page call.
", + "documentation": "A token that indicates where a results page should begin.
", "location": "querystring", "locationName": "nextToken" }, @@ -534,16 +3349,16 @@ } } }, - "ListEnvironmentsResponse": { + "ListKxUsersResponse": { "type": "structure", "members": { - "environments": { - "shape": "EnvironmentList", - "documentation": "A list of all of your FinSpace environments.
" + "users": { + "shape": "KxUserList", + "documentation": "A list of users in a kdb environment.
" }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token that you can use in a subsequent call to retrieve the next set of results.
" + "documentation": "A token that indicates where a results page should begin.
" } } }, @@ -554,7 +3369,7 @@ ], "members": { "resourceArn": { - "shape": "EnvironmentArn", + "shape": "FinSpaceTaggableArn", "documentation": "The Amazon Resource Name of the resource.
", "location": "uri", "locationName": "resourceArn" @@ -570,22 +3385,73 @@ } } }, - "NameString": { + "MaxResults": { + "type": "integer", + "max": 100, + "min": 0 + }, + "NameString": { + "type": "string", + "max": 50, + "min": 1, + "pattern": "^[a-zA-Z0-9]{1,50}$" + }, + "NodeCount": { + "type": "integer", + "max": 5, + "min": 1 + }, + "NodeType": { + "type": "string", + "max": 32, + "min": 1, + "pattern": "^[a-zA-Z0-9._]+" + }, + "PaginationToken": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": ".*" + }, + "ReleaseLabel": { + "type": "string", + "max": 16, + "min": 1, + "pattern": "^[a-zA-Z0-9._-]+" + }, + "ResultLimit": { + "type": "integer", + "max": 100, + "min": 0 + }, + "RoleArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "S3Bucket": { "type": "string", - "max": 50, + "max": 255, + "min": 3, + "pattern": "^[a-z0-9][a-z0-9\\.\\-]*[a-z0-9]$" + }, + "S3Key": { + "type": "string", + "max": 1024, "min": 1, - "pattern": "^[a-zA-Z0-9]{1,50}$" + "pattern": "^[a-zA-Z0-9\\/\\!\\-_\\.\\*'\\(\\)]+$" }, - "PaginationToken": { + "S3ObjectVersion": { "type": "string", "max": 1000, - "min": 1, - "pattern": ".*" + "min": 1 }, - "ResultLimit": { - "type": "integer", - "max": 100, - "min": 0 + "S3Path": { + "type": "string", + "max": 1093, + "min": 9, + "pattern": "^s3:\\/\\/[a-z0-9][a-z0-9-]{1,61}[a-z0-9]\\/([^\\/]+\\/)*[^\\/]*$" }, "SamlMetadataDocument": { "type": "string", @@ -593,12 +3459,43 @@ "min": 1000, "pattern": ".*" }, + "SecurityGroupIdList": { + "type": "list", + "member": { + "shape": "SecurityGroupIdString" + } + }, + "SecurityGroupIdString": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "^sg-([a-z0-9]{8}$|[a-z0-9]{17}$)" + }, + "SignedKxConnectionString": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "^(:|:tcps:\\/\\/)[a-zA-Z0-9-\\.\\_]+:\\d+:[a-zA-Z0-9-\\.\\_]+:\\S+$", + "sensitive": true + }, "SmsDomainUrl": { "type": "string", "max": 1000, "min": 1, "pattern": "^[a-zA-Z-0-9-:\\/.]*$" }, + "SubnetIdList": { + "type": "list", + "member": { + "shape": "SubnetIdString" + } + }, + "SubnetIdString": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "^subnet-([a-z0-9]{8}$|[a-z0-9]{17}$)" + }, "SuperuserParameters": { "type": "structure", "required": [ @@ -655,7 +3552,7 @@ ], "members": { "resourceArn": { - "shape": "EnvironmentArn", + "shape": "FinSpaceTaggableArn", "documentation": "The Amazon Resource Name (ARN) for the resource.
", "location": "uri", "locationName": "resourceArn" @@ -676,6 +3573,32 @@ "min": 1, "pattern": "^[a-zA-Z0-9+-=._:@ ]+$" }, + "Timestamp": { + "type": "timestamp" + }, + "TransitGatewayConfiguration": { + "type": "structure", + "required": [ + "transitGatewayID", + "routableCIDRSpace" + ], + "members": { + "transitGatewayID": { + "shape": "TransitGatewayID", + "documentation": "The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
" + }, + "routableCIDRSpace": { + "shape": "ValidCIDRSpace", + "documentation": "The routing CIDR on behalf of kdb environment. It could be any \"/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.
" + } + }, + "documentation": "The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
" + }, + "TransitGatewayID": { + "type": "string", + "max": 32, + "min": 1 + }, "UntagResourceRequest": { "type": "structure", "required": [ @@ -684,7 +3607,7 @@ ], "members": { "resourceArn": { - "shape": "EnvironmentArn", + "shape": "FinSpaceTaggableArn", "documentation": "A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
", "location": "uri", "locationName": "resourceArn" @@ -739,6 +3662,407 @@ } } }, + "UpdateKxClusterDatabasesRequest": { + "type": "structure", + "required": [ + "environmentId", + "clusterName", + "databases" + ], + "members": { + "environmentId": { + "shape": "KxEnvironmentId", + "documentation": "The unique identifier of a kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "clusterName": { + "shape": "KxClusterName", + "documentation": "A unique name for the cluster that you want to modify.
", + "location": "uri", + "locationName": "clusterName" + }, + "clientToken": { + "shape": "ClientTokenString", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
" + }, + "databases": { + "shape": "KxDatabaseConfigurations", + "documentation": "The structure of databases mounted on the cluster.
" + } + } + }, + "UpdateKxClusterDatabasesResponse": { + "type": "structure", + "members": {} + }, + "UpdateKxDatabaseRequest": { + "type": "structure", + "required": [ + "environmentId", + "databaseName", + "clientToken" + ], + "members": { + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
", + "location": "uri", + "locationName": "databaseName" + }, + "description": { + "shape": "Description", + "documentation": "A description of the database.
" + }, + "clientToken": { + "shape": "ClientTokenString", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "idempotencyToken": true + } + } + }, + "UpdateKxDatabaseResponse": { + "type": "structure", + "members": { + "databaseName": { + "shape": "DatabaseName", + "documentation": "The name of the kdb database.
" + }, + "environmentId": { + "shape": "EnvironmentId", + "documentation": "A unique identifier for the kdb environment.
" + }, + "description": { + "shape": "Description", + "documentation": "A description of the database.
" + }, + "lastModifiedTimestamp": { + "shape": "Timestamp", + "documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "UpdateKxEnvironmentNetworkRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "transitGatewayConfiguration": { + "shape": "TransitGatewayConfiguration", + "documentation": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
" + }, + "customDNSConfiguration": { + "shape": "CustomDNSConfiguration", + "documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
" + } + } + }, + "UpdateKxEnvironmentNetworkResponse": { + "type": "structure", + "members": { + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "awsAccountId": { + "shape": "IdType", + "documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" + }, + "status": { + "shape": "EnvironmentStatus", + "documentation": "The status of the kdb environment.
" + }, + "tgwStatus": { + "shape": "tgwStatus", + "documentation": "The status of the network configuration.
" + }, + "dnsStatus": { + "shape": "dnsStatus", + "documentation": "The status of DNS configuration.
" + }, + "errorMessage": { + "shape": "EnvironmentErrorMessage", + "documentation": "Specifies the error message that appears if a flow fails.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the environment.
" + }, + "environmentArn": { + "shape": "EnvironmentArn", + "documentation": "The ARN identifier of the environment.
" + }, + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + }, + "dedicatedServiceAccountId": { + "shape": "IdType", + "documentation": "A unique identifier for the AWS environment infrastructure account.
" + }, + "transitGatewayConfiguration": { + "shape": "TransitGatewayConfiguration" + }, + "customDNSConfiguration": { + "shape": "CustomDNSConfiguration", + "documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + }, + "creationTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + }, + "updateTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was updated.
" + }, + "availabilityZoneIds": { + "shape": "AvailabilityZoneIds", + "documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + } + }, + "UpdateKxEnvironmentRequest": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment.
" + }, + "description": { + "shape": "Description", + "documentation": "A description of the kdb environment.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
" + } + } + }, + "UpdateKxEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "shape": "KxEnvironmentName", + "documentation": "The name of the kdb environment.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "awsAccountId": { + "shape": "IdType", + "documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" + }, + "status": { + "shape": "EnvironmentStatus", + "documentation": "The status of the kdb environment.
" + }, + "tgwStatus": { + "shape": "tgwStatus", + "documentation": "The status of the network configuration.
" + }, + "dnsStatus": { + "shape": "dnsStatus", + "documentation": "The status of DNS configuration.
" + }, + "errorMessage": { + "shape": "EnvironmentErrorMessage", + "documentation": "Specifies the error message that appears if a flow fails.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the environment.
" + }, + "environmentArn": { + "shape": "EnvironmentArn", + "documentation": "The ARN identifier of the environment.
" + }, + "kmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + }, + "dedicatedServiceAccountId": { + "shape": "IdType", + "documentation": "A unique identifier for the AWS environment infrastructure account.
" + }, + "transitGatewayConfiguration": { + "shape": "TransitGatewayConfiguration" + }, + "customDNSConfiguration": { + "shape": "CustomDNSConfiguration", + "documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + }, + "creationTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + }, + "updateTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp at which the kdb environment was updated.
" + }, + "availabilityZoneIds": { + "shape": "AvailabilityZoneIds", + "documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + } + }, + "UpdateKxUserRequest": { + "type": "structure", + "required": [ + "environmentId", + "userName", + "iamRole" + ], + "members": { + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
", + "location": "uri", + "locationName": "environmentId" + }, + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user.
", + "location": "uri", + "locationName": "userName" + }, + "iamRole": { + "shape": "RoleArn", + "documentation": "The IAM role ARN that is associated with the user.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "A token that ensures idempotency. This token expires in 10 minutes.
" + } + } + }, + "UpdateKxUserResponse": { + "type": "structure", + "members": { + "userName": { + "shape": "KxUserNameString", + "documentation": "A unique identifier for the user.
" + }, + "userArn": { + "shape": "KxUserArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
" + }, + "environmentId": { + "shape": "IdType", + "documentation": "A unique identifier for the kdb environment.
" + }, + "iamRole": { + "shape": "RoleArn", + "documentation": "The IAM role ARN that is associated with the user.
" + } + } + }, + "ValidCIDRSpace": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\/26$" + }, + "ValidHostname": { + "type": "string", + "max": 255, + "min": 3, + "pattern": "^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])(\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]))*$" + }, + "ValidIPAddress": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" + }, + "VpcConfiguration": { + "type": "structure", + "members": { + "vpcId": { + "shape": "VpcIdString", + "documentation": "The identifier of the VPC endpoint.
" + }, + "securityGroupIds": { + "shape": "SecurityGroupIdList", + "documentation": "The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
" + }, + "subnetIds": { + "shape": "SubnetIdList", + "documentation": "The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
" + }, + "ipAddressType": { + "shape": "IPAddressType", + "documentation": "The IP address type for cluster network configuration parameters. The following type is available:
IP_V4 – IP address version 4
Configuration details about the network where the Privatelink endpoint of the cluster resides.
" + }, + "VpcIdString": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "^vpc-([a-z0-9]{8}$|[a-z0-9]{17}$)" + }, + "dnsStatus": { + "type": "string", + "enum": [ + "NONE", + "UPDATE_REQUESTED", + "UPDATING", + "FAILED_UPDATE", + "SUCCESSFULLY_UPDATED" + ] + }, + "numBytes": { + "type": "long" + }, + "numChangesets": { + "type": "integer" + }, + "numFiles": { + "type": "integer" + }, + "stringValueLength1to255": { + "type": "string", + "max": 255, + "min": 1 + }, + "tgwStatus": { + "type": "string", + "enum": [ + "NONE", + "UPDATE_REQUESTED", + "UPDATING", + "FAILED_UPDATE", + "SUCCESSFULLY_UPDATED" + ] + }, "url": { "type": "string", "max": 1000, diff --git a/apis/finspace-2021-03-12.paginators.json b/apis/finspace-2021-03-12.paginators.json index 5677bd8e4a..ca77facdbe 100644 --- a/apis/finspace-2021-03-12.paginators.json +++ b/apis/finspace-2021-03-12.paginators.json @@ -1,4 +1,25 @@ { "pagination": { + "ListKxChangesets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListKxClusterNodes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListKxDatabases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListKxEnvironments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "environments" + } } } diff --git a/apis/frauddetector-2019-11-15.min.json b/apis/frauddetector-2019-11-15.min.json index 03e1192693..85d552205f 100644 --- a/apis/frauddetector-2019-11-15.min.json +++ b/apis/frauddetector-2019-11-15.min.json @@ -1414,7 +1414,10 @@ }, "lastUpdatedTime": {}, "createdTime": {}, - "arn": {} + "arn": {}, + "eventOrchestration": { + "shape": "S6g" + } }, "sensitive": true } @@ -1446,10 +1449,10 @@ "modelSource": {}, "invokeModelEndpointRoleArn": {}, "inputConfiguration": { - "shape": "S6l" + "shape": "S6m" }, "outputConfiguration": { - "shape": "S6p" + "shape": "S6q" }, "modelEndpointStatus": {}, "lastUpdatedTime": {}, @@ -1736,16 +1739,16 @@ "type": "structure", "members": { "eventId": { - "shape": "S7v" + "shape": "S7w" }, "eventType": { - "shape": "S7v" + "shape": "S7w" }, "detectorId": { - "shape": "S7v" + "shape": "S7w" }, "detectorVersionId": { - "shape": "S7v" + "shape": "S7w" }, "predictionTimeRange": { "type": "structure", @@ -1872,6 +1875,9 @@ "eventIngestion": {}, "tags": { "shape": "S5" + }, + "eventOrchestration": { + "shape": "S6g" } } }, @@ -1896,10 +1902,10 @@ "modelSource": {}, "invokeModelEndpointRoleArn": {}, "inputConfiguration": { - "shape": "S6l" + "shape": "S6m" }, "outputConfiguration": { - "shape": "S6p" + "shape": "S6q" }, "modelEndpointStatus": {}, "tags": { @@ -2532,7 +2538,18 @@ "value": {}, "sensitive": true }, - "S6l": { + "S6g": { + "type": "structure", + "required": [ + "eventBridgeEnabled" + ], + "members": { + "eventBridgeEnabled": { + "type": "boolean" + } + } + }, + "S6m": { "type": "structure", "required": [ "useEventVariables" @@ -2547,7 +2564,7 @@ "csvInputTemplate": {} } }, - "S6p": { + "S6q": { "type": "structure", "required": [ "format" @@ -2566,7 +2583,7 @@ } } }, - "S7v": { + "S7w": { "type": "structure", "members": { "value": {} diff --git a/apis/frauddetector-2019-11-15.normal.json b/apis/frauddetector-2019-11-15.normal.json index 60a308d68c..d190bc865c 100644 --- a/apis/frauddetector-2019-11-15.normal.json +++ b/apis/frauddetector-2019-11-15.normal.json @@ -544,7 +544,7 @@ "shape": "ValidationException" } ], - "documentation": "Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector.
" + "documentation": "Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. If deleteAuditHistory
is True
, event data is available through search for up to 30 seconds after the delete operation is completed.
The data type.
" + "documentation": "The data type of the variable.
" }, "dataSource": { "shape": "DataSource", @@ -3078,7 +3078,8 @@ "STRING", "INTEGER", "FLOAT", - "BOOLEAN" + "BOOLEAN", + "DATETIME" ] }, "DataValidationMetrics": { @@ -3200,7 +3201,7 @@ }, "deleteAuditHistory": { "shape": "DeleteAuditHistory", - "documentation": "Specifies whether or not to delete any predictions associated with the event.
" + "documentation": "Specifies whether or not to delete any predictions associated with the event. If set to True
,
Specifies if event orchestration is enabled through Amazon EventBridge.
" + } + }, + "documentation": "The event orchestration status.
" + }, "EventPredictionSummary": { "type": "structure", "members": { @@ -3826,6 +3840,10 @@ "arn": { "shape": "fraudDetectorArn", "documentation": "The entity type ARN.
" + }, + "eventOrchestration": { + "shape": "EventOrchestration", + "documentation": "The event orchestration status.
" } }, "documentation": "The event type details.
", @@ -4908,7 +4926,7 @@ }, "unlabeledEventsTreatment": { "shape": "UnlabeledEventsTreatment", - "documentation": "The action to take for unlabeled events.
Use IGNORE
if you want the unlabeled events to be ignored. This is recommended when the majority of the events in the dataset are labeled.
Use FRAUD
if you want to categorize all unlabeled events as “Fraud”. This is recommended when most of the events in your dataset are fraudulent.
Use LEGIT
f you want to categorize all unlabeled events as “Legit”. This is recommended when most of the events in your dataset are legitimate.
Use AUTO
if you want Amazon Fraud Detector to decide how to use the unlabeled data. This is recommended when there is significant unlabeled events in the dataset.
By default, Amazon Fraud Detector ignores the unlabeled data.
" + "documentation": "The action to take for unlabeled events.
Use IGNORE
if you want the unlabeled events to be ignored. This is recommended when the majority of the events in the dataset are labeled.
Use FRAUD
if you want to categorize all unlabeled events as “Fraud”. This is recommended when most of the events in your dataset are fraudulent.
Use LEGIT
if you want to categorize all unlabeled events as “Legit”. This is recommended when most of the events in your dataset are legitimate.
Use AUTO
if you want Amazon Fraud Detector to decide how to use the unlabeled data. This is recommended when there is significant unlabeled events in the dataset.
By default, Amazon Fraud Detector ignores the unlabeled data.
" } }, "documentation": "The label schema.
" @@ -5645,11 +5663,15 @@ }, "eventIngestion": { "shape": "EventIngestion", - "documentation": "Specifies if ingenstion is enabled or disabled.
" + "documentation": "Specifies if ingestion is enabled or disabled.
" }, "tags": { "shape": "tagList", "documentation": "A collection of key and value pairs.
" + }, + "eventOrchestration": { + "shape": "EventOrchestration", + "documentation": "Enables or disables event orchestration. If enabled, you can send event predictions to select AWS services for downstream processing of the events.
" } } }, @@ -5734,7 +5756,7 @@ }, "tags": { "shape": "tagList", - "documentation": "" + "documentation": "A collection of key and value pairs.
" } } }, @@ -6125,7 +6147,7 @@ }, "upperBoundValue": { "shape": "float", - "documentation": "The lower bound value of the area under curve (auc).
" + "documentation": "The upper bound value of the area under curve (auc).
" } }, "documentation": "Range of area under curve (auc) expected from the model. A range greater than 0.1 indicates higher model uncertainity. A range is the difference between upper and lower bound of auc.
" @@ -6925,5 +6947,5 @@ "pattern": "^([1-9][0-9]*)$" } }, - "documentation": "This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action
. AWS SDK provides libraries, sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see Tools to build on AWS.
This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action
. AWS SDK provides libraries, sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, go to Tools to build on AWS page, scroll down to the SDK section, and choose plus (+) sign to expand the section.
The default arguments for this job.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "documentation": "The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
" }, "NonOverridableArguments": { "shape": "GenericMap", - "documentation": "Non-overridable arguments for this job, specified as name-value pairs.
" + "documentation": "Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
" }, "Connections": { "shape": "ConnectionsList", @@ -9599,7 +9599,7 @@ }, "MaxCapacity": { "shape": "NullableDouble", - "documentation": "For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" + "documentation": "In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" }, "NumberOfWorkers": { "shape": "NullableInteger", @@ -9623,7 +9623,7 @@ }, "WorkerType": { "shape": "WorkerType", - "documentation": "The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers based on the autoscaler.
The default arguments for this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "documentation": "The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
" }, "NonOverridableArguments": { "shape": "GenericMap", - "documentation": "Non-overridable arguments for this job, specified as name-value pairs.
" + "documentation": "Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
" }, "Connections": { "shape": "ConnectionsList", @@ -15863,11 +15863,11 @@ }, "MaxCapacity": { "shape": "NullableDouble", - "documentation": "For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPU, 64 GB of memory, 256 GB disk), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later jobs.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPU, 128 GB of memory, 512 GB disk), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, G.4X, G.8X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPU, 64 GB of memory, 256 GB disk), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPU, 128 GB of memory, 512 GB disk), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides a default of 8 Ray workers (1 per vCPU).
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" + "documentation": "In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" }, "CodeGenConfigurationNodes": { "shape": "CodeGenConfigurationNodes", @@ -15960,7 +15960,7 @@ "members": { "Name": { "shape": "GenericString", - "documentation": "The name of the job command. For an Apache Spark ETL job, this must be glueetl
. For a Python shell job, it must be pythonshell
. For an Apache Spark streaming ETL job, this must be gluestreaming
.
The name of the job command. For an Apache Spark ETL job, this must be glueetl
. For a Python shell job, it must be pythonshell
. For an Apache Spark streaming ETL job, this must be gluestreaming
. For a Ray job, this must be glueray
.
The Python version being used to run a Python shell job. Allowed values are 2 or 3.
" + }, + "Runtime": { + "shape": "RuntimeNameString", + "documentation": "In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Working with Ray jobs in the Glue Developer Guide.
" } }, "documentation": "Specifies code that runs when a job is run.
" @@ -16039,7 +16043,7 @@ }, "Arguments": { "shape": "GenericMap", - "documentation": "The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "documentation": "The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
" }, "ErrorMessage": { "shape": "ErrorString", @@ -16065,11 +16069,11 @@ }, "MaxCapacity": { "shape": "NullableDouble", - "documentation": "The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers (one per vCPU) based on the autoscaler.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" + "documentation": "In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" }, "DPUSeconds": { "shape": "NullableDouble", @@ -16147,11 +16151,11 @@ }, "DefaultArguments": { "shape": "GenericMap", - "documentation": "The default arguments for this job.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "documentation": "The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
" }, "NonOverridableArguments": { "shape": "GenericMap", - "documentation": "Non-overridable arguments for this job, specified as name-value pairs.
" + "documentation": "Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
" }, "Connections": { "shape": "ConnectionsList", @@ -16173,11 +16177,11 @@ }, "MaxCapacity": { "shape": "NullableDouble", - "documentation": "For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers based on the autoscaler.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
" + "documentation": "In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
" }, "CodeGenConfigurationNodes": { "shape": "CodeGenConfigurationNodes", @@ -19263,6 +19267,11 @@ } } }, + "RuntimeNameString": { + "type": "string", + "max": 64, + "pattern": ".*" + }, "S3CatalogDeltaSource": { "type": "structure", "required": [ @@ -21061,7 +21070,7 @@ }, "Arguments": { "shape": "GenericMap", - "documentation": "The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "documentation": "The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
" }, "AllocatedCapacity": { "shape": "IntegerValue", @@ -21075,7 +21084,7 @@ }, "MaxCapacity": { "shape": "NullableDouble", - "documentation": "The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
=\"glueetl\") or Apache Spark streaming ETL job (JobCommand.Name
=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers (one per vCPU) based on the autoscaler.
Returns the number of minutes used by account.
" + "documentation": "Returns the number of reserved minutes used by account.
" }, "GetMissionProfile": { "name": "GetMissionProfile", diff --git a/apis/healthlake-2017-07-01.min.json b/apis/healthlake-2017-07-01.min.json index 454f925cab..1b3c0965f7 100644 --- a/apis/healthlake-2017-07-01.min.json +++ b/apis/healthlake-2017-07-01.min.json @@ -34,6 +34,9 @@ }, "Tags": { "shape": "Sb" + }, + "IdentityProviderConfiguration": { + "shape": "Sf" } } }, @@ -56,6 +59,9 @@ "DeleteFHIRDatastore": { "input": { "type": "structure", + "required": [ + "DatastoreId" + ], "members": { "DatastoreId": {} } @@ -79,6 +85,9 @@ "DescribeFHIRDatastore": { "input": { "type": "structure", + "required": [ + "DatastoreId" + ], "members": { "DatastoreId": {} } @@ -90,7 +99,7 @@ ], "members": { "DatastoreProperties": { - "shape": "So" + "shape": "St" } } } @@ -114,7 +123,7 @@ ], "members": { "ExportJobProperties": { - "shape": "Su" + "shape": "Sz" } } } @@ -138,7 +147,7 @@ ], "members": { "ImportJobProperties": { - "shape": "S14" + "shape": "S19" } } } @@ -175,7 +184,7 @@ "DatastorePropertiesList": { "type": "list", "member": { - "shape": "So" + "shape": "St" } }, "NextToken": {} @@ -213,7 +222,7 @@ "ExportJobPropertiesList": { "type": "list", "member": { - "shape": "Su" + "shape": "Sz" } }, "NextToken": {} @@ -251,7 +260,7 @@ "ImportJobPropertiesList": { "type": "list", "member": { - "shape": "S14" + "shape": "S19" } }, "NextToken": {} @@ -289,7 +298,7 @@ "members": { "JobName": {}, "OutputDataConfig": { - "shape": "Sx" + "shape": "S12" }, "DatastoreId": {}, "DataAccessRoleArn": {}, @@ -324,10 +333,10 @@ "members": { "JobName": {}, "InputDataConfig": { - "shape": "S15" + "shape": "S1a" }, "JobOutputDataConfig": { - "shape": "Sx" + "shape": "S12" }, "DatastoreId": {}, "DataAccessRoleArn": {}, @@ -431,7 +440,21 @@ } } }, - "So": { + "Sf": { + "type": "structure", + "required": [ + "AuthorizationStrategy" + ], + "members": { + "AuthorizationStrategy": {}, + "FineGrainedAuthorizationEnabled": { + "type": "boolean" + }, + "Metadata": {}, + "IdpLambdaArn": {} + } + }, + "St": { "type": "structure", "required": [ "DatastoreId", @@ -455,10 +478,13 @@ }, "PreloadDataConfig": { "shape": "S8" + }, + "IdentityProviderConfiguration": { + "shape": "Sf" } } }, - "Su": { + "Sz": { "type": "structure", "required": [ "JobId", @@ -479,13 +505,13 @@ }, "DatastoreId": {}, "OutputDataConfig": { - "shape": "Sx" + "shape": "S12" }, "DataAccessRoleArn": {}, "Message": {} } }, - "Sx": { + "S12": { "type": "structure", "members": { "S3Configuration": { @@ -502,7 +528,7 @@ }, "union": true }, - "S14": { + "S19": { "type": "structure", "required": [ "JobId", @@ -523,16 +549,16 @@ }, "DatastoreId": {}, "InputDataConfig": { - "shape": "S15" + "shape": "S1a" }, "JobOutputDataConfig": { - "shape": "Sx" + "shape": "S12" }, "DataAccessRoleArn": {}, "Message": {} } }, - "S15": { + "S1a": { "type": "structure", "members": { "S3Uri": {} diff --git a/apis/healthlake-2017-07-01.normal.json b/apis/healthlake-2017-07-01.normal.json index 658ed1b98c..c274f27f16 100644 --- a/apis/healthlake-2017-07-01.normal.json +++ b/apis/healthlake-2017-07-01.normal.json @@ -351,7 +351,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Adds a user specifed key and value tag to a Data Store.
" + "documentation": "Adds a user specified key and value tag to a Data Store.
" }, "UntagResource": { "name": "UntagResource", @@ -383,6 +383,16 @@ "min": 1, "pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\\d{12}:datastore\\/fhir\\/.{32}" }, + "AuthorizationStrategy": { + "type": "string", + "enum": [ + "SMART_ON_FHIR_V1", + "AWS_AUTH" + ] + }, + "Boolean": { + "type": "boolean" + }, "BoundedLengthString": { "type": "string", "max": 5000, @@ -402,6 +412,9 @@ "AWS_OWNED_KMS_KEY" ] }, + "ConfigurationMetadata": { + "type": "string" + }, "CreateFHIRDatastoreRequest": { "type": "structure", "required": [ @@ -432,6 +445,10 @@ "Tags": { "shape": "TagList", "documentation": "Resource tags that are applied to a Data Store when it is created.
" + }, + "IdentityProviderConfiguration": { + "shape": "IdentityProviderConfiguration", + "documentation": "The configuration of the identity provider that you want to use for your Data Store.
" } } }, @@ -450,7 +467,7 @@ }, "DatastoreArn": { "shape": "DatastoreArn", - "documentation": "The datastore ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation call.
" + "documentation": "The Data Store ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation call.
" }, "DatastoreStatus": { "shape": "DatastoreStatus", @@ -458,7 +475,7 @@ }, "DatastoreEndpoint": { "shape": "BoundedLengthString", - "documentation": "The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported.
" + "documentation": "The AWS endpoint for the created Data Store.
" } } }, @@ -545,9 +562,13 @@ "PreloadDataConfig": { "shape": "PreloadDataConfig", "documentation": "The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
" + }, + "IdentityProviderConfiguration": { + "shape": "IdentityProviderConfiguration", + "documentation": "The identity provider that you selected when you created the Data Store.
" } }, - "documentation": "Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.
" + "documentation": "Displays the properties of the Data Store, including the ID, ARN, name, and the status of the Data Store.
" }, "DatastorePropertiesList": { "type": "list", @@ -566,6 +587,9 @@ }, "DeleteFHIRDatastoreRequest": { "type": "structure", + "required": [ + "DatastoreId" + ], "members": { "DatastoreId": { "shape": "DatastoreId", @@ -602,10 +626,13 @@ }, "DescribeFHIRDatastoreRequest": { "type": "structure", + "required": [ + "DatastoreId" + ], "members": { "DatastoreId": { "shape": "DatastoreId", - "documentation": "The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’ output.
" + "documentation": "The AWS-generated Data Store ID.
" } } }, @@ -752,6 +779,31 @@ "min": 20, "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" }, + "IdentityProviderConfiguration": { + "type": "structure", + "required": [ + "AuthorizationStrategy" + ], + "members": { + "AuthorizationStrategy": { + "shape": "AuthorizationStrategy", + "documentation": "The authorization strategy that you selected when you created the Data Store.
" + }, + "FineGrainedAuthorizationEnabled": { + "shape": "Boolean", + "documentation": "If you enabled fine-grained authorization when you created the Data Store.
" + }, + "Metadata": { + "shape": "ConfigurationMetadata", + "documentation": "The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.
authorization_endpoint
: The URL to the OAuth2 authorization endpoint.
grant_types_supported
: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code
and client_credentials
.
token_endpoint
: The URL to the OAuth2 token endpoint.
capabilities
: An array of strings of the SMART capabilities that the authorization server supports.
code_challenge_methods_supported
: An array of strings of supported PKCE code challenge methods. You must include the S256
method in the array of PKCE code challenge methods.
The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
" + } + }, + "documentation": "The identity provider configuration that you gave when the Data Store was created.
" + }, "ImportJobProperties": { "type": "structure", "required": [ @@ -772,7 +824,7 @@ }, "JobStatus": { "shape": "JobStatus", - "documentation": "The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED.
" + "documentation": "The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.
" }, "SubmitTime": { "shape": "Timestamp", @@ -840,7 +892,11 @@ "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", - "FAILED" + "FAILED", + "CANCEL_SUBMITTED", + "CANCEL_IN_PROGRESS", + "CANCEL_COMPLETED", + "CANCEL_FAILED" ] }, "KmsEncryptionConfig": { @@ -860,6 +916,12 @@ }, "documentation": "The customer-managed-key(CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption.
" }, + "LambdaArn": { + "type": "string", + "max": 256, + "min": 49, + "pattern": "arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?" + }, "ListFHIRDatastoresRequest": { "type": "structure", "members": { @@ -1228,7 +1290,7 @@ }, "Value": { "shape": "TagValue", - "documentation": "The value portion of tag. Tag values are case sensitive.
" + "documentation": "The value portion of a tag. Tag values are case sensitive.
" } }, "documentation": "A tag is a label consisting of a user-defined key and value. The form for tags is {\"Key\", \"Value\"}
" diff --git a/apis/iotfleetwise-2021-06-17.min.json b/apis/iotfleetwise-2021-06-17.min.json index 62a34804bc..a5e617db83 100644 --- a/apis/iotfleetwise-2021-06-17.min.json +++ b/apis/iotfleetwise-2021-06-17.min.json @@ -186,6 +186,9 @@ }, "tags": { "shape": "Sd" + }, + "dataDestinationConfigs": { + "shape": "S1j" } } }, @@ -210,10 +213,10 @@ "description": {}, "modelManifestArn": {}, "signalDecoders": { - "shape": "S1m" + "shape": "S1w" }, "networkInterfaces": { - "shape": "S20" + "shape": "S2a" }, "tags": { "shape": "Sd" @@ -274,7 +277,7 @@ "name": {}, "description": {}, "nodes": { - "shape": "S2e" + "shape": "S2o" }, "signalCatalogArn": {}, "tags": { @@ -305,7 +308,7 @@ "name": {}, "description": {}, "nodes": { - "shape": "S2h" + "shape": "S2r" }, "tags": { "shape": "Sd" @@ -551,6 +554,9 @@ }, "lastModificationTime": { "type": "timestamp" + }, + "dataDestinationConfigs": { + "shape": "S1j" } } } @@ -633,7 +639,7 @@ ], "members": { "cloudWatchLogDelivery": { - "shape": "S3f" + "shape": "S3q" } } } @@ -681,7 +687,6 @@ "required": [ "customerAccountId", "accountStatus", - "timestreamRegistrationResponse", "iamRegistrationResponse", "creationTime", "lastModificationTime" @@ -985,7 +990,7 @@ "type": "structure", "members": { "networkInterfaces": { - "shape": "S20" + "shape": "S2a" }, "nextToken": {} } @@ -1009,7 +1014,7 @@ "type": "structure", "members": { "signalDecoders": { - "shape": "S1m" + "shape": "S1w" }, "nextToken": {} } @@ -1140,7 +1145,7 @@ "type": "structure", "members": { "nodes": { - "shape": "S2h" + "shape": "S2r" }, "nextToken": {} } @@ -1205,7 +1210,7 @@ "type": "structure", "members": { "nodes": { - "shape": "S2h" + "shape": "S2r" }, "nextToken": {} } @@ -1340,7 +1345,7 @@ ], "members": { "cloudWatchLogDelivery": { - "shape": "S3f" + "shape": "S3q" } } }, @@ -1353,15 +1358,14 @@ "RegisterAccount": { "input": { "type": "structure", - "required": [ - "timestreamResources" - ], "members": { "timestreamResources": { - "shape": "S5r" + "shape": "S62", + "deprecated": true, + "deprecatedMessage": "Amazon Timestream metadata is now passed in the CreateCampaign API." }, "iamResources": { - "shape": "S5s", + "shape": "S63", "deprecated": true, "deprecatedMessage": "iamResources is no longer used or needed as input" } @@ -1371,7 +1375,6 @@ "type": "structure", "required": [ "registerAccountStatus", - "timestreamResources", "iamResources", "creationTime", "lastModificationTime" @@ -1379,10 +1382,10 @@ "members": { "registerAccountStatus": {}, "timestreamResources": { - "shape": "S5r" + "shape": "S62" }, "iamResources": { - "shape": "S5s" + "shape": "S63" }, "creationTime": { "type": "timestamp" @@ -1469,20 +1472,20 @@ "name": {}, "description": {}, "signalDecodersToAdd": { - "shape": "S1m" + "shape": "S1w" }, "signalDecodersToUpdate": { - "shape": "S1m" + "shape": "S1w" }, "signalDecodersToRemove": { "type": "list", "member": {} }, "networkInterfacesToAdd": { - "shape": "S20" + "shape": "S2a" }, "networkInterfacesToUpdate": { - "shape": "S20" + "shape": "S2a" }, "networkInterfacesToRemove": { "type": "list", @@ -1533,10 +1536,10 @@ "name": {}, "description": {}, "nodesToAdd": { - "shape": "S6a" + "shape": "S6k" }, "nodesToRemove": { - "shape": "S6a" + "shape": "S6k" }, "status": {} } @@ -1564,13 +1567,13 @@ "name": {}, "description": {}, "nodesToAdd": { - "shape": "S2h" + "shape": "S2r" }, "nodesToUpdate": { - "shape": "S2h" + "shape": "S2r" }, "nodesToRemove": { - "shape": "S6a" + "shape": "S6k" } } }, @@ -1687,7 +1690,39 @@ "type": "list", "member": {} }, - "S1m": { + "S1j": { + "type": "list", + "member": { + "type": "structure", + "members": { + "s3Config": { + "type": "structure", + "required": [ + "bucketArn" + ], + "members": { + "bucketArn": {}, + "dataFormat": {}, + "storageCompressionFormat": {}, + "prefix": {} + } + }, + "timestreamConfig": { + "type": "structure", + "required": [ + "timestreamTableArn", + "executionRoleArn" + ], + "members": { + "timestreamTableArn": {}, + "executionRoleArn": {} + } + } + }, + "union": true + } + }, + "S1w": { "type": "list", "member": { "type": "structure", @@ -1780,7 +1815,7 @@ } } }, - "S20": { + "S2a": { "type": "list", "member": { "type": "structure", @@ -1831,11 +1866,11 @@ } } }, - "S2e": { + "S2o": { "type": "list", "member": {} }, - "S2h": { + "S2r": { "type": "list", "member": { "type": "structure", @@ -1847,7 +1882,9 @@ ], "members": { "fullyQualifiedName": {}, - "description": {} + "description": {}, + "deprecationMessage": {}, + "comment": {} } }, "sensor": { @@ -1862,14 +1899,16 @@ "description": {}, "unit": {}, "allowedValues": { - "shape": "S2e" + "shape": "S2o" }, "min": { "type": "double" }, "max": { "type": "double" - } + }, + "deprecationMessage": {}, + "comment": {} } }, "actuator": { @@ -1884,7 +1923,7 @@ "description": {}, "unit": {}, "allowedValues": { - "shape": "S2e" + "shape": "S2o" }, "min": { "type": "double" @@ -1895,7 +1934,9 @@ "assignedValue": { "deprecated": true, "deprecatedMessage": "assignedValue is no longer in use" - } + }, + "deprecationMessage": {}, + "comment": {} } }, "attribute": { @@ -1910,7 +1951,7 @@ "description": {}, "unit": {}, "allowedValues": { - "shape": "S2e" + "shape": "S2o" }, "min": { "type": "double" @@ -1922,14 +1963,16 @@ "deprecated": true, "deprecatedMessage": "assignedValue is no longer in use" }, - "defaultValue": {} + "defaultValue": {}, + "deprecationMessage": {}, + "comment": {} } } }, "union": true } }, - "S3f": { + "S3q": { "type": "structure", "required": [ "logType" @@ -1939,7 +1982,7 @@ "logGroupName": {} } }, - "S5r": { + "S62": { "type": "structure", "required": [ "timestreamDatabaseName", @@ -1950,7 +1993,7 @@ "timestreamTableName": {} } }, - "S5s": { + "S63": { "type": "structure", "required": [ "roleArn" @@ -1959,7 +2002,7 @@ "roleArn": {} } }, - "S6a": { + "S6k": { "type": "list", "member": {} } diff --git a/apis/iotfleetwise-2021-06-17.normal.json b/apis/iotfleetwise-2021-06-17.normal.json index 7c7a51929c..414b845891 100644 --- a/apis/iotfleetwise-2021-06-17.normal.json +++ b/apis/iotfleetwise-2021-06-17.normal.json @@ -337,7 +337,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
", + "documentation": "Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
", "idempotent": true }, "DeleteCampaign": { @@ -1372,7 +1372,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.
An Amazon Web Services account is not the same thing as a \"user account\". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.
This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.
You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.
If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference.
<p>Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up Amazon Web Services IoT FleetWise</a>. </p> <note> <p>An Amazon Web Services account is <b>not</b> the same thing as a "user." An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users">Amazon Web Services user</a> is an identity that you create using Identity and Access Management (IAM) and takes the form of either an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html">IAM user</a> or an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM role, both with credentials</a>. A single Amazon Web Services account can, and typically does, contain many users and roles.</p> </note>
"
},
"TagResource": {
"name": "TagResource",
@@ -1705,6 +1705,14 @@
"documentation": "A specified value for the actuator.
", "deprecated": true, "deprecatedMessage": "assignedValue is no longer in use" + }, + "deprecationMessage": { + "shape": "message", + "documentation": "The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment": { + "shape": "message", + "documentation": "A comment in addition to the description.
" } }, "documentation": "A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.
Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
The default value of the attribute.
" + }, + "deprecationMessage": { + "shape": "message", + "documentation": "The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment": { + "shape": "message", + "documentation": "A comment in addition to the description.
" } }, "documentation": "A signal that represents static information about the vehicle, such as engine type or manufacturing date.
" @@ -1846,6 +1862,14 @@ "description": { "shape": "description", "documentation": "A brief description of the branch.
" + }, + "deprecationMessage": { + "shape": "message", + "documentation": "The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment": { + "shape": "message", + "documentation": "A comment in addition to the description.
" } }, "documentation": "A group of signals that are defined in a hierarchical structure.
" @@ -1975,11 +1999,11 @@ }, "startBit": { "shape": "nonNegativeInteger", - "documentation": "Indicates the beginning of the CAN message.
" + "documentation": "Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit
is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit
.
Indicates where data appears in the CAN message.
" + "documentation": "The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset
.
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
" + "documentation": "(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
" }, "postTriggerCollectionDuration": { "shape": "uint32", @@ -2139,6 +2163,10 @@ "tags": { "shape": "TagList", "documentation": "Metadata that can be used to manage the campaign.
" + }, + "dataDestinationConfigs": { + "shape": "DataDestinationConfigs", + "documentation": "The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
" } } }, @@ -2375,7 +2403,7 @@ }, "attributes": { "shape": "attributesMap", - "documentation": "Static information about a vehicle in a key-value pair. For example: \"engineType\"
: \"1.3 L R2\"
Static information about a vehicle in a key-value pair. For example: \"engineType\"
: \"1.3 L R2\"
A campaign must include the keys (attribute names) in dataExtraDimensions
for them to display in Amazon Timestream.
Information about a created vehicle.
" }, + "DataDestinationConfig": { + "type": "structure", + "members": { + "s3Config": { + "shape": "S3Config", + "documentation": "The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
" + }, + "timestreamConfig": { + "shape": "TimestreamConfig", + "documentation": "The Amazon Timestream table where the campaign sends data.
" + } + }, + "documentation": "The destination where the Amazon Web Services IoT FleetWise campaign sends data. You can send data to be stored in Amazon S3 or Amazon Timestream.
", + "union": true + }, + "DataDestinationConfigs": { + "type": "list", + "member": { + "shape": "DataDestinationConfig" + }, + "max": 1, + "min": 1 + }, "DataExtraDimensionNodePathList": { "type": "list", "member": { @@ -2465,6 +2516,13 @@ "max": 5, "min": 0 }, + "DataFormat": { + "type": "string", + "enum": [ + "JSON", + "PARQUET" + ] + }, "DecoderManifestSummary": { "type": "structure", "required": [ @@ -2741,7 +2799,7 @@ "documentation": "Provides the VSS in JSON format.
" } }, - "documentation": "Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.
", + "documentation": "Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.
", "union": true }, "Fqns": { @@ -2843,6 +2901,10 @@ "lastModificationTime": { "shape": "timestamp", "documentation": "The last time the campaign was modified.
" + }, + "dataDestinationConfigs": { + "shape": "DataDestinationConfigs", + "documentation": "The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
" } } }, @@ -3021,7 +3083,6 @@ "required": [ "customerAccountId", "accountStatus", - "timestreamRegistrationResponse", "iamRegistrationResponse", "creationTime", "lastModificationTime" @@ -4015,7 +4076,7 @@ }, "offset": { "shape": "double", - "documentation": "Indicates where data appears in the message.
" + "documentation": "The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset
.
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
" + }, + "dataFormat": { + "shape": "DataFormat", + "documentation": "Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.
By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
" + }, + "prefix": { + "shape": "Prefix", + "documentation": "(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/
(in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles
, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/
.
The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.
" + }, "Sensor": { "type": "structure", "required": [ @@ -4157,6 +4253,14 @@ "max": { "shape": "double", "documentation": "The specified possible maximum value of the sensor.
" + }, + "deprecationMessage": { + "shape": "message", + "documentation": "The deprecation message for the node or the branch that was moved or deleted.
" + }, + "comment": { + "shape": "message", + "documentation": "A comment in addition to the description.
" } }, "documentation": "An input component that reports the environmental condition of a vehicle.
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
Information about a collection scheme that uses a time period to decide how often to collect data.
" }, + "TimestreamConfig": { + "type": "structure", + "required": [ + "timestreamTableArn", + "executionRoleArn" + ], + "members": { + "timestreamTableArn": { + "shape": "TimestreamTableArn", + "documentation": "The Amazon Resource Name (ARN) of the Amazon Timestream table.
" + }, + "executionRoleArn": { + "shape": "IAMRoleArn", + "documentation": "The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
" + } + }, + "documentation": "The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide.
" + }, "TimestreamDatabaseName": { "type": "string", "max": 255, @@ -4405,6 +4534,12 @@ }, "documentation": "The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
" }, + "TimestreamTableArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "arn:(aws[a-zA-Z0-9-]*):timestream:[a-zA-Z0-9-]+:[0-9]{12}:database/[a-zA-Z0-9_.-]+/table/[a-zA-Z0-9_.-]+" + }, "TimestreamTableName": { "type": "string", "max": 255, @@ -4469,7 +4604,7 @@ }, "action": { "shape": "UpdateCampaignAction", - "documentation": "Specifies how to update a campaign. The action can be one of the following:
APPROVE
- To approve delivering a data collection scheme to vehicles.
SUSPEND
- To suspend collecting signal data.
RESUME
- To resume collecting signal data.
UPDATE
- To update a campaign.
Specifies how to update a campaign. The action can be one of the following:
APPROVE
- To approve delivering a data collection scheme to vehicles.
SUSPEND
- To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.
RESUME
- To reactivate the SUSPEND
campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.
UPDATE
- To update a campaign.
Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
" + "documentation": "Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.
" } }, "shapes": { @@ -903,6 +903,10 @@ "shape": "PlaybackURL", "documentation": "Channel playback URL.
" }, + "preset": { + "shape": "TranscodePreset", + "documentation": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
and ADVANCED_SD
channel types. For those channel types, the default preset
is HIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
and STANDARD
), preset
is the empty string (\"\"
).
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (empty string, recording is disabled).
" @@ -913,7 +917,7 @@ }, "type": { "shape": "ChannelType", - "documentation": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
. Valid values:
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC
: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD
. Valid values:
BASIC
: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.
ADVANCED_SD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
ADVANCED_HD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
Optional transcode presets (available for the ADVANCED
types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:
Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)
Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).
Object specifying a channel.
" @@ -980,6 +984,10 @@ "shape": "ChannelName", "documentation": "Channel name.
" }, + "preset": { + "shape": "TranscodePreset", + "documentation": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
and ADVANCED_SD
channel types. For those channel types, the default preset
is HIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
and STANDARD
), preset
is the empty string (\"\"
).
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (empty string, recording is disabled).
" @@ -987,6 +995,10 @@ "tags": { "shape": "Tags", "documentation": "Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value)
. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD
. Valid values:
BASIC
: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.
ADVANCED_SD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
ADVANCED_HD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
Optional transcode presets (available for the ADVANCED
types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:
Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)
Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).
Summary information about a channel.
" @@ -995,7 +1007,9 @@ "type": "string", "enum": [ "BASIC", - "STANDARD" + "STANDARD", + "ADVANCED_SD", + "ADVANCED_HD" ] }, "Channels": { @@ -1023,6 +1037,10 @@ "shape": "ChannelName", "documentation": "Channel name.
" }, + "preset": { + "shape": "TranscodePreset", + "documentation": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
and ADVANCED_SD
channel types. For those channel types, the default preset
is HIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
and STANDARD
), preset
is the empty string (\"\"
).
Recording-configuration ARN. Default: \"\" (empty string, recording is disabled).
" @@ -1033,7 +1051,7 @@ }, "type": { "shape": "ChannelType", - "documentation": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
. Valid values:
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC
: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD
. Valid values:
BASIC
: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.
ADVANCED_SD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
ADVANCED_HD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
Optional transcode presets (available for the ADVANCED
types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:
Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)
Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).
Channel name.
" }, + "preset": { + "shape": "TranscodePreset", + "documentation": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
and ADVANCED_SD
channel types. For those channel types, the default preset
is HIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
and STANDARD
), preset
is the empty string (\"\"
).
Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled
" }, "type": { "shape": "ChannelType", - "documentation": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC
: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD
. Valid values:
BASIC
: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.
STANDARD
: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.
ADVANCED_SD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
ADVANCED_HD
: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.
Optional transcode presets (available for the ADVANCED
types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:
Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)
Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
" + "documentation": "Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
" }, "UntagResource": { "name": "UntagResource", @@ -587,6 +587,10 @@ "tags": { "shape": "TagList", "documentation": "A list of key-value pair tags to be attached to the keyspace.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
" + }, + "replicationSpecification": { + "shape": "ReplicationSpecification", + "documentation": "The replication specification of the keyspace includes:
replicationStrategy
- the required value is SINGLE_REGION
or MULTI_REGION
.
regionList
- if the replicationStrategy
is MULTI_REGION
, the regionList
requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in. The maximum number of supported replication Regions including the current Region is six.
The ARN of the keyspace.
" + "documentation": "Returns the ARN of the keyspace.
" + }, + "replicationStrategy": { + "shape": "rs", + "documentation": " Returns the replication strategy of the keyspace. The options are SINGLE_REGION
or MULTI_REGION
.
If the replicationStrategy
of the keyspace is MULTI_REGION
, a list of replication Regions is returned.
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
" + }, + "replicationStrategy": { + "shape": "rs", + "documentation": " This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION
or MULTI_REGION
.
If the replicationStrategy
of the keyspace is MULTI_REGION
, a list of replication Regions is returned.
Represents the properties of a keyspace.
" @@ -1039,6 +1061,31 @@ }, "documentation": "The point-in-time recovery status of the specified table.
" }, + "RegionList": { + "type": "list", + "member": { + "shape": "region" + }, + "max": 6, + "min": 2 + }, + "ReplicationSpecification": { + "type": "structure", + "required": [ + "replicationStrategy" + ], + "members": { + "replicationStrategy": { + "shape": "rs", + "documentation": " The replicationStrategy
of a keyspace, the required value is SINGLE_REGION
or MULTI_REGION
.
The regionList
can contain up to six Amazon Web Services Regions where the keyspace is replicated in.
The replication specification of the keyspace includes:
regionList
- up to six Amazon Web Services Regions where the keyspace is replicated in.
replicationStrategy
- the required value is SINGLE_REGION
or MULTI_REGION
.
Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.
In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.
For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.
For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.
" diff --git a/apis/kms-2014-11-01.examples.json b/apis/kms-2014-11-01.examples.json index fa8740ac4f..283cc1d9b0 100644 --- a/apis/kms-2014-11-01.examples.json +++ b/apis/kms-2014-11-01.examples.json @@ -410,7 +410,7 @@ "KeyMetadata": "Detailed information about the KMS key that this operation creates." } }, - "description": "This example creates a KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL.", + "description": "This example creates a symmetric KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL.", "id": "to-create-a-kms-key-for-imported-key-material-5", "title": "To create a KMS key for imported key material" }, @@ -1440,25 +1440,112 @@ "output": { "ImportToken": "Creates a unique customer managed KMS key in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources.
A KMS key is a logical representation of a cryptographic key. In addition to the key material used in cryptographic operations, a KMS key includes metadata, such as the key ID, key policy, creation date, description, and key state. For details, see Managing keys in the Key Management Service Developer Guide
Use the parameters of CreateKey
to specify the type of KMS key, the source of its key material, its key policy, description, tags, and other properties.
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
To create different types of KMS keys, use the following guidance:
By default, CreateKey
creates a symmetric encryption KMS key with key material that KMS generates. This is the basic and most widely used type of KMS key, and provides the best performance.
To create a symmetric encryption KMS key, you don't need to specify any parameters. The default value for KeySpec
, SYMMETRIC_DEFAULT
, the default value for KeyUsage
, ENCRYPT_DECRYPT
, and the default value for Origin
, AWS_KMS
, create a symmetric encryption KMS key with KMS key material.
If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
To create an asymmetric KMS key, use the KeySpec
parameter to specify the type of key material in the KMS key. Then, use the KeyUsage
parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created.
Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To create an HMAC KMS key, set the KeySpec
parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage
parameter to GENERATE_VERIFY_MAC
. You must set the key usage even though GENERATE_VERIFY_MAC
is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created.
HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.
HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the CreateKey
operation returns an UnsupportedOperationException
. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.
To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion
parameter with a value of True
. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation.
You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
To import your own key material into a KMS key, begin by creating a symmetric encryption KMS key with no key material. To do this, use the Origin
parameter of CreateKey
with a value of EXTERNAL
. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide .
This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key material into any other type of KMS key.
To create a multi-Region primary key with imported key material, use the Origin
parameter of CreateKey
with a value of EXTERNAL
and the MultiRegion
parameter with a value of True
. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material into multi-Region keys. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
A custom key store lets you protect your Amazon Web Services resources using keys in a backing key store that you own and manage. When you request a cryptographic operation with a KMS key in a custom key store, the operation is performed in the backing key store using its cryptographic keys.
KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store, KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you specify an existing encryption key in the external key manager.
Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.
Before you create a KMS key in a custom key store, the ConnectionState
of the key store must be CONNECTED
. To connect the custom key store, use the ConnectCustomKeyStore operation. To find the ConnectionState
, use the DescribeCustomKeyStores operation.
To create a KMS key in a custom key store, use the CustomKeyStoreId
. Use the default KeySpec
value, SYMMETRIC_DEFAULT
, and the default KeyUsage
value, ENCRYPT_DECRYPT
to create a symmetric encryption key. No other key type is supported in a custom key store.
To create a KMS key in an CloudHSM key store, use the Origin
parameter with a value of AWS_CLOUDHSM
. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region.
To create a KMS key in an external key store, use the Origin
parameter with a value of EXTERNAL_KEY_STORE
and an XksKeyId
parameter that identifies an existing external key.
Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.
Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account.
Required permissions: kms:CreateKey (IAM policy). To use the Tags
parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide.
Related operations:
" + "documentation": "Creates a unique customer managed KMS key in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources.
A KMS key is a logical representation of a cryptographic key. In addition to the key material used in cryptographic operations, a KMS key includes metadata, such as the key ID, key policy, creation date, description, and key state. For details, see Managing keys in the Key Management Service Developer Guide
Use the parameters of CreateKey
to specify the type of KMS key, the source of its key material, its key policy, description, tags, and other properties.
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
To create different types of KMS keys, use the following guidance:
By default, CreateKey
creates a symmetric encryption KMS key with key material that KMS generates. This is the basic and most widely used type of KMS key, and provides the best performance.
To create a symmetric encryption KMS key, you don't need to specify any parameters. The default value for KeySpec
, SYMMETRIC_DEFAULT
, the default value for KeyUsage
, ENCRYPT_DECRYPT
, and the default value for Origin
, AWS_KMS
, create a symmetric encryption KMS key with KMS key material.
If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
To create an asymmetric KMS key, use the KeySpec
parameter to specify the type of key material in the KMS key. Then, use the KeyUsage
parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created.
Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To create an HMAC KMS key, set the KeySpec
parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage
parameter to GENERATE_VERIFY_MAC
. You must set the key usage even though GENERATE_VERIFY_MAC
is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created.
HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.
To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion
parameter with a value of True
. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation.
You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
To import your own key material into a KMS key, begin by creating a KMS key with no key material. To do this, use the Origin
parameter of CreateKey
with a value of EXTERNAL
. Next, use GetParametersForImport operation to get a public key and import token. Use the wrapping public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide .
You can import key material into KMS keys of all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't import key material into a KMS key in a custom key store.
To create a multi-Region primary key with imported key material, use the Origin
parameter of CreateKey
with a value of EXTERNAL
and the MultiRegion
parameter with a value of True
. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material into multi-Region keys. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
A custom key store lets you protect your Amazon Web Services resources using keys in a backing key store that you own and manage. When you request a cryptographic operation with a KMS key in a custom key store, the operation is performed in the backing key store using its cryptographic keys.
KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store, KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you specify an existing encryption key in the external key manager.
Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.
Before you create a KMS key in a custom key store, the ConnectionState
of the key store must be CONNECTED
. To connect the custom key store, use the ConnectCustomKeyStore operation. To find the ConnectionState
, use the DescribeCustomKeyStores operation.
To create a KMS key in a custom key store, use the CustomKeyStoreId
. Use the default KeySpec
value, SYMMETRIC_DEFAULT
, and the default KeyUsage
value, ENCRYPT_DECRYPT
to create a symmetric encryption key. No other key type is supported in a custom key store.
To create a KMS key in an CloudHSM key store, use the Origin
parameter with a value of AWS_CLOUDHSM
. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region.
To create a KMS key in an external key store, use the Origin
parameter with a value of EXTERNAL_KEY_STORE
and an XksKeyId
parameter that identifies an existing external key.
Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.
Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account.
Required permissions: kms:CreateKey (IAM policy). To use the Tags
parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide.
Related operations:
" }, "Decrypt": { "name": "Decrypt", @@ -399,7 +399,7 @@ "shape": "KMSInvalidStateException" } ], - "documentation": "Deletes key material that you previously imported. This operation makes the specified KMS key unusable. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.
When the specified KMS key is in the PendingDeletion
state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the KMS key.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DeleteImportedKeyMaterial (key policy)
Related operations:
" + "documentation": "Deletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.
When the specified KMS key is in the PendingDeletion
state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport
.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DeleteImportedKeyMaterial (key policy)
Related operations:
" }, "DescribeCustomKeyStores": { "name": "DescribeCustomKeyStores", @@ -977,7 +977,7 @@ "shape": "KMSInvalidStateException" } ], - "documentation": "Returns the items you need to import key material into a symmetric encryption KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
You must specify the key ID of the symmetric encryption KMS key into which you will import key material. The KMS key Origin
must be EXTERNAL
. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.
To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the GetParametersForImport
response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport
request.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
" + "documentation": "Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport
, use the CreateKey operation with an Origin
value of EXTERNAL
to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport
to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport
returns the items that you need to import your key material.
The public key (or \"wrapping key\") of an RSA key pair that KMS generates.
You will use this public key to encrypt (\"wrap\") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo
field in the GetParametersForImport
response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport
request.
GetParametersForImport
requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key (\"wrapping key\") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
" }, "GetPublicKey": { "name": "GetPublicKey", @@ -1069,7 +1069,7 @@ "shape": "InvalidImportTokenException" } ], - "documentation": "Imports key material into an existing symmetric encryption KMS key that was created without key material. After you successfully import key material into a KMS key, you can reimport the same key material into that KMS key, but you cannot import different key material.
You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material and then importing key material, see Importing Key Material in the Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport
response.
When calling this operation, you must specify the following values:
The key ID or key ARN of a KMS key with no key material. Its Origin
must be EXTERNAL
.
To create a KMS key with no key material, call CreateKey and set the value of its Origin
parameter to EXTERNAL
. To get the Origin
of a KMS key, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport
response.
Whether the key material expires (ExpirationModel
) and, if so, when (ValidTo
). If you set an expiration date, on the specified date, KMS deletes the key material from the KMS key, making the KMS key unusable. To use the KMS key in cryptographic operations again, you must reimport the same key material. The only way to change the expiration model or expiration date is by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the key state of the KMS key changes from PendingImport
to Enabled
, and you can use the KMS key.
If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key and repeat the import procedure. For help, see How To Import Key Material in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ImportKeyMaterial (key policy)
Related operations:
" + "documentation": "Imports or reimports key material into an existing KMS key that was created without key material. ImportKeyMaterial
also sets the expiration model and expiration date of the imported key material.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
After you successfully import key material into a KMS key, you can reimport the same key material into that KMS key, but you cannot import different key material. You might reimport key material to replace key material that expired or key material that you deleted. You might also reimport key material to change the expiration model or expiration date of the key material. Before reimporting key material, if necessary, call DeleteImportedKeyMaterial to delete the current imported key material.
Each time you import key material into KMS, you can determine whether (ExpirationModel
) and when (ValidTo
) the key material expires. To change the expiration of your key material, you must import it again, either by calling ImportKeyMaterial
or using the import features of the KMS console.
Before calling ImportKeyMaterial
:
Create or identify a KMS key with no key material. The KMS key must have an Origin
value of EXTERNAL
, which indicates that the KMS key is designed for imported key material.
To create an new KMS key for imported key material, call the CreateKey operation with an Origin
value of EXTERNAL
. You can create a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store.
Use the DescribeKey operation to verify that the KeyState
of the KMS key is PendingImport
, which indicates that the KMS key has no key material.
If you are reimporting the same key material into an existing KMS key, you might need to call the DeleteImportedKeyMaterial to delete its existing key material.
Call the GetParametersForImport operation to get a public key and import token set for importing key material.
Use the public key in the GetParametersForImport response to encrypt your key material.
Then, in an ImportKeyMaterial
request, you submit your encrypted key material and import token. When calling this operation, you must specify the following values:
The key ID or key ARN of the KMS key to associate with the imported key material. Its Origin
must be EXTERNAL
and its KeyState
must be PendingImport
. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account. To get the Origin
and KeyState
of a KMS key, call DescribeKey.
The encrypted key material.
The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport
response.
Whether the key material expires (ExpirationModel
) and, if so, when (ValidTo
). For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.
If you set an expiration date, KMS deletes the key material from the KMS key on the specified date, making the KMS key unusable. To use the KMS key in cryptographic operations again, you must reimport the same key material. However, you can delete and reimport the key material at any time, including before the key material expires. Each time you reimport, you can eliminate or reset the expiration time.
When this operation is successful, the key state of the KMS key changes from PendingImport
to Enabled
, and you can use the KMS key in cryptographic operations.
If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key and repeat the import procedure. For help, see How To Import Key Material in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ImportKeyMaterial (key policy)
Related operations:
" }, "ListAliases": { "name": "ListAliases", @@ -1477,7 +1477,7 @@ "shape": "KMSInvalidStateException" } ], - "documentation": "Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion
and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it.
Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use DisableKey.
You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion
and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion
and its waiting period (PendingWindowInDays
) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide.
When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material.
For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ScheduleKeyDeletion (key policy)
Related operations
" + "documentation": "Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion
and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it.
Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material[BUGBUG-link to importing-keys-managing.html#import-delete-key.) To prevent the use of a KMS key without deleting it, use DisableKey.
You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion
and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion
and its waiting period (PendingWindowInDays
) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide.
When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material.
For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ScheduleKeyDeletion (key policy)
Related operations
" }, "Sign": { "name": "Sign", @@ -1825,7 +1825,9 @@ "enum": [ "RSAES_PKCS1_V1_5", "RSAES_OAEP_SHA_1", - "RSAES_OAEP_SHA_256" + "RSAES_OAEP_SHA_256", + "RSA_AES_KEY_WRAP_SHA_1", + "RSA_AES_KEY_WRAP_SHA_256" ] }, "AliasList": { @@ -2889,15 +2891,15 @@ "members": { "KeyId": { "shape": "KeyIdType", - "documentation": "The identifier of the symmetric encryption KMS key into which you will import key material. The Origin
of the KMS key must be EXTERNAL
.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
" + "documentation": "The identifier of the KMS key that will be associated with the imported key material. The Origin
of the KMS key must be EXTERNAL
.
All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS key in a custom key store.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
" }, "WrappingAlgorithm": { "shape": "AlgorithmSpec", - "documentation": "The algorithm you will use to encrypt the key material before using the ImportKeyMaterial operation to import it. For more information, see Encrypt the key material in the Key Management Service Developer Guide.
The RSAES_PKCS1_V1_5
wrapping algorithm is deprecated. We recommend that you begin using a different wrapping algorithm immediately. KMS will end support for RSAES_PKCS1_V1_5
by October 1, 2023 pursuant to cryptographic key management guidance from the National Institute of Standards and Technology (NIST).
The algorithm you will use with the RSA public key (PublicKey
) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS.
The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.
RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_PKCS1_V1_5 (Deprecated) — Supported only for symmetric encryption key material (and only in legacy mode).
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
" + "documentation": "The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import.
Use the longest RSA wrapping key that is practical.
You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
" } } }, @@ -3096,7 +3098,7 @@ "members": { "KeyId": { "shape": "KeyIdType", - "documentation": "The identifier of the symmetric encryption KMS key that receives the imported key material. This must be the same KMS key specified in the KeyID
parameter of the corresponding GetParametersForImport request. The Origin
of the KMS key must be EXTERNAL
. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
" + "documentation": "The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in the KeyID
parameter of the corresponding GetParametersForImport request. The Origin
of the KMS key must be EXTERNAL
and its KeyState
must be PendingImport
.
The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
" }, "ImportToken": { "shape": "CiphertextType", @@ -3104,7 +3106,7 @@ }, "EncryptedKeyMaterial": { "shape": "CiphertextType", - "documentation": "The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport
request.
The encrypted key material to import. The key material must be encrypted under the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport
request.
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES
.
When the value of ExpirationModel
is KEY_MATERIAL_EXPIRES
, you must specify a value for the ValidTo
parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.
When the value of ExpirationModel
is KEY_MATERIAL_EXPIRES
, you must specify a value for the ValidTo
parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.
The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
" + "documentation": "The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. You can use the kms:ScheduleKeyDeletionPendingWindowInDays
condition key to further constrain the values that principals can specify in the PendingWindowInDays
parameter.
The cryptographic signature that was generated for the message.
When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
When used with the ECDSA_SHA_256
, ECDSA_SHA_384
, or ECDSA_SHA_512
signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
" + "documentation": "The cryptographic signature that was generated for the message.
When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
When used with the ECDSA_SHA_256
, ECDSA_SHA_384
, or ECDSA_SHA_512
signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
" }, "SigningAlgorithm": { "shape": "SigningAlgorithmSpec", @@ -4230,7 +4232,9 @@ "WrappingKeySpec": { "type": "string", "enum": [ - "RSA_2048" + "RSA_2048", + "RSA_3072", + "RSA_4096" ] }, "XksKeyConfigurationType": { diff --git a/apis/lambda-2015-03-31.normal.json b/apis/lambda-2015-03-31.normal.json index 3b22069964..e029786b62 100644 --- a/apis/lambda-2015-03-31.normal.json +++ b/apis/lambda-2015-03-31.normal.json @@ -2831,7 +2831,7 @@ }, "KMSKeyArn": { "shape": "KMSKeyArn", - "documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key.
" + "documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
" }, "TracingConfig": { "shape": "TracingConfig", @@ -3370,7 +3370,7 @@ }, "MaximumRecordAgeInSeconds": { "shape": "MaximumRecordAgeInSeconds", - "documentation": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum value that can be set is 60 seconds.
(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
The layer's compatible runtimes.
" + "documentation": "The layer's compatible runtimes.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
" }, "LicenseInfo": { "shape": "LicenseInfo", @@ -4808,7 +4808,7 @@ }, "CompatibleRuntimes": { "shape": "CompatibleRuntimes", - "documentation": "The layer's compatible runtimes.
" + "documentation": "The layer's compatible runtimes.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
" }, "LicenseInfo": { "shape": "LicenseInfo", @@ -5143,7 +5143,7 @@ "members": { "CompatibleRuntime": { "shape": "Runtime", - "documentation": "A runtime identifier. For example, go1.x
.
A runtime identifier. For example, go1.x
.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
", "location": "querystring", "locationName": "CompatibleRuntime" }, @@ -5191,7 +5191,7 @@ "members": { "CompatibleRuntime": { "shape": "Runtime", - "documentation": "A runtime identifier. For example, go1.x
.
A runtime identifier. For example, go1.x
.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
", "location": "querystring", "locationName": "CompatibleRuntime" }, @@ -5572,7 +5572,7 @@ }, "CompatibleRuntimes": { "shape": "CompatibleRuntimes", - "documentation": "A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
" + "documentation": "A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
" }, "LicenseInfo": { "shape": "LicenseInfo", @@ -5613,7 +5613,7 @@ }, "CompatibleRuntimes": { "shape": "CompatibleRuntimes", - "documentation": "The layer's compatible runtimes.
" + "documentation": "The layer's compatible runtimes.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
" }, "LicenseInfo": { "shape": "LicenseInfo", @@ -5981,7 +5981,8 @@ "provided.al2", "nodejs18.x", "python3.10", - "java17" + "java17", + "ruby3.2" ] }, "RuntimeVersionArn": { @@ -6604,7 +6605,7 @@ }, "KMSKeyArn": { "shape": "KMSKeyArn", - "documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key.
" + "documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
" }, "TracingConfig": { "shape": "TracingConfig", diff --git a/apis/location-2020-11-19.min.json b/apis/location-2020-11-19.min.json index ba6134fe69..42cbaee9bb 100644 --- a/apis/location-2020-11-19.min.json +++ b/apis/location-2020-11-19.min.json @@ -814,7 +814,7 @@ "members": { "DataSource": {}, "DataSourceConfiguration": { - "shape": "S3k" + "shape": "S3l" }, "Description": {}, "IndexName": {}, @@ -1304,7 +1304,7 @@ }, "DataSource": {}, "DataSourceConfiguration": { - "shape": "S3k" + "shape": "S3l" }, "Description": {}, "IndexArn": {}, @@ -1855,7 +1855,7 @@ ], "members": { "Place": { - "shape": "S58" + "shape": "S59" } } }, @@ -2485,7 +2485,7 @@ "type": "double" }, "Place": { - "shape": "S58" + "shape": "S59" }, "PlaceId": {} } @@ -2533,7 +2533,7 @@ "shape": "S2g" }, "FilterCountries": { - "shape": "S6y" + "shape": "S6z" }, "IndexName": { "location": "uri", @@ -2584,14 +2584,14 @@ "shape": "S2g" }, "FilterCountries": { - "shape": "S6y" + "shape": "S6z" }, "Language": {}, "MaxResults": { "type": "integer" }, "Text": { - "shape": "S76" + "shape": "S77" } } } @@ -2620,7 +2620,7 @@ "shape": "S2g" }, "FilterCountries": { - "shape": "S6y" + "shape": "S6z" }, "IndexName": { "location": "uri", @@ -2655,7 +2655,7 @@ "type": "double" }, "Place": { - "shape": "S58" + "shape": "S59" }, "PlaceId": {}, "Relevance": { @@ -2679,7 +2679,7 @@ "shape": "S2g" }, "FilterCountries": { - "shape": "S6y" + "shape": "S6z" }, "Language": {}, "MaxResults": { @@ -2689,7 +2689,7 @@ "shape": "S2g" }, "Text": { - "shape": "S76" + "shape": "S77" } } } @@ -2872,6 +2872,12 @@ "MapName" ], "members": { + "ConfigurationUpdate": { + "type": "structure", + "members": { + "PoliticalView": {} + } + }, "Description": {}, "MapName": { "location": "uri", @@ -2916,7 +2922,7 @@ ], "members": { "DataSourceConfiguration": { - "shape": "S3k" + "shape": "S3l" }, "Description": {}, "IndexName": { @@ -3248,16 +3254,17 @@ "Style" ], "members": { + "PoliticalView": {}, "Style": {} } }, - "S3k": { + "S3l": { "type": "structure", "members": { "IntendedUse": {} } }, - "S58": { + "S59": { "type": "structure", "required": [ "Geometry" @@ -3299,11 +3306,11 @@ "UnitType": {} } }, - "S6y": { + "S6z": { "type": "list", "member": {} }, - "S76": { + "S77": { "type": "string", "sensitive": true } diff --git a/apis/location-2020-11-19.normal.json b/apis/location-2020-11-19.normal.json index 87563bd4d9..b54504958d 100644 --- a/apis/location-2020-11-19.normal.json +++ b/apis/location-2020-11-19.normal.json @@ -554,6 +554,9 @@ { "shape": "ValidationException" }, + { + "shape": "ServiceQuotaExceededException" + }, { "shape": "ThrottlingException" } @@ -2074,7 +2077,9 @@ }, "ApiKeyAction": { "type": "string", - "pattern": "^geo:GetMap\\*$" + "max": 200, + "min": 5, + "pattern": "^geo:\\w*\\*?$" }, "ApiKeyFilter": { "type": "structure", @@ -2113,7 +2118,7 @@ "member": { "shape": "ApiKeyAction" }, - "max": 1, + "max": 5, "min": 1 }, "ApiKeyRestrictionsAllowReferersList": { @@ -2987,6 +2992,18 @@ "type": "string", "pattern": "^[A-Z]{3}$" }, + "CountryCode3": { + "type": "string", + "max": 3, + "min": 3, + "pattern": "^[A-Z]{3}$" + }, + "CountryCode3OrEmpty": { + "type": "string", + "max": 3, + "min": 0, + "pattern": "^[A-Z]{3}$|^$" + }, "CountryCodeList": { "type": "list", "member": { @@ -3214,7 +3231,7 @@ "documentation": "The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
The optional description for the place index resource.
" }, "IndexArn": { - "shape": "Arn", + "shape": "GeoArn", "documentation": "The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services.
Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode
.
Valid fonts stacks for Esri styles:
VectorEsriDarkGrayCanvas – Ubuntu Medium Italic
| Ubuntu Medium
| Ubuntu Italic
| Ubuntu Regular
| Ubuntu Bold
VectorEsriLightGrayCanvas – Ubuntu Italic
| Ubuntu Regular
| Ubuntu Light
| Ubuntu Bold
VectorEsriTopographic – Noto Sans Italic
| Noto Sans Regular
| Noto Sans Bold
| Noto Serif Regular
| Roboto Condensed Light Italic
VectorEsriStreets – Arial Regular
| Arial Italic
| Arial Bold
VectorEsriNavigation – Arial Regular
| Arial Italic
| Arial Bold
Valid font stacks for HERE Technologies styles:
VectorHereContrast – Fira GO Regular
| Fira GO Bold
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic
| Fira GO Map
| Fira GO Map Bold
| Noto Sans CJK JP Bold
| Noto Sans CJK JP Light
| Noto Sans CJK JP Regular
Valid font stacks for GrabMaps styles:
VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular
| Noto Sans Medium
| Noto Sans Bold
Valid font stacks for Open Data styles:
VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular
| Amazon Ember Bold,Noto Sans Bold
| Amazon Ember Medium,Noto Sans Medium
| Amazon Ember Regular Italic,Noto Sans Italic
| Amazon Ember Condensed RC Regular,Noto Sans Regular
| Amazon Ember Condensed RC Bold,Noto Sans Bold
The fonts used by the Open Data map styles are combined fonts that use Amazon Ember
for most glyphs but Noto Sans
for glyphs unsupported by Amazon Ember
.
A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode
.
Valid fonts stacks for Esri styles:
VectorEsriDarkGrayCanvas – Ubuntu Medium Italic
| Ubuntu Medium
| Ubuntu Italic
| Ubuntu Regular
| Ubuntu Bold
VectorEsriLightGrayCanvas – Ubuntu Italic
| Ubuntu Regular
| Ubuntu Light
| Ubuntu Bold
VectorEsriTopographic – Noto Sans Italic
| Noto Sans Regular
| Noto Sans Bold
| Noto Serif Regular
| Roboto Condensed Light Italic
VectorEsriStreets – Arial Regular
| Arial Italic
| Arial Bold
VectorEsriNavigation – Arial Regular
| Arial Italic
| Arial Bold
Valid font stacks for HERE Technologies styles:
VectorHereContrast – Fira GO Regular
| Fira GO Bold
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic
| Fira GO Map
| Fira GO Map Bold
| Noto Sans CJK JP Bold
| Noto Sans CJK JP Light
| Noto Sans CJK JP Regular
Valid font stacks for GrabMaps styles:
VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular
| Noto Sans Medium
| Noto Sans Bold
Valid font stacks for Open Data styles:
VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular
| Amazon Ember Bold,Noto Sans Bold
| Amazon Ember Medium,Noto Sans Medium
| Amazon Ember Regular Italic,Noto Sans Italic
| Amazon Ember Condensed RC Regular,Noto Sans Regular
| Amazon Ember Condensed RC Bold,Noto Sans Bold
| Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
| Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold
| Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
| Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular
| Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular
| Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
The fonts used by the Open Data map styles are combined fonts that use Amazon Ember
for most glyphs but Noto Sans
for glyphs unsupported by Amazon Ember
.
Specifies the political view for the style. Leave unset to not use a political view, or, for styles that support specific political views, you can choose a view, such as IND
for the Indian view.
Default is unset.
Not all map resources or styles support political view styles. See Political views for more information.
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas
– The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
RasterEsriImagery
– The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.
VectorEsriLightGrayCanvas
– The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.
VectorEsriTopographic
– The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
VectorEsriStreets
– The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
VectorEsriNavigation
– The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid HERE Technologies map styles:
VectorHereContrast
– The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.
The VectorHereContrast
style has been renamed from VectorHereBerlin
. VectorHereBerlin
has been deprecated, but will continue to work in applications that use it.
VectorHereExplore
– A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.
VectorHereExploreTruck
– A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.
RasterHereExploreSatellite
– A global map containing high resolution satellite imagery.
HybridHereExploreSatellite
– A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid GrabMaps map styles:
VectorGrabStandardLight
– The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.
VectorGrabStandardDark
– The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region (ap-southeast-1
). For more information, see GrabMaps countries and area covered.
Valid Open Data map styles:
VectorOpenDataStandardLight
– The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataStandardDark
– Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataVisualizationLight
– The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.
VectorOpenDataVisualizationDark
– The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas
– The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
RasterEsriImagery
– The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.
VectorEsriLightGrayCanvas
– The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.
VectorEsriTopographic
– The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
VectorEsriStreets
– The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
VectorEsriNavigation
– The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid HERE Technologies map styles:
VectorHereContrast
– The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.
The VectorHereContrast
style has been renamed from VectorHereBerlin
. VectorHereBerlin
has been deprecated, but will continue to work in applications that use it.
VectorHereExplore
– A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.
VectorHereExploreTruck
– A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.
RasterHereExploreSatellite
– A global map containing high resolution satellite imagery.
HybridHereExploreSatellite
– A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid GrabMaps map styles:
VectorGrabStandardLight
– The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.
VectorGrabStandardDark
– The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region (ap-southeast-1
). For more information, see GrabMaps countries and area covered.
Valid Open Data map styles:
VectorOpenDataStandardLight
– The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataStandardDark
– Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataVisualizationLight
– The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.
VectorOpenDataVisualizationDark
– The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.
Specifies the map tile style selected from an available provider.
" }, + "MapConfigurationUpdate": { + "type": "structure", + "members": { + "PoliticalView": { + "shape": "CountryCode3OrEmpty", + "documentation": "Specifies the political view for the style. Set to an empty string to not use a political view, or, for styles that support specific political views, you can choose a view, such as IND
for the Indian view.
Not all map resources or styles support political view styles. See Political views for more information.
Specifies the political view for the style.
" + }, "MapStyle": { "type": "string", "max": 100, @@ -6274,6 +6305,10 @@ "MapName" ], "members": { + "ConfigurationUpdate": { + "shape": "MapConfigurationUpdate", + "documentation": "Updates the parts of the map configuration that can be updated, including the political view.
" + }, "Description": { "shape": "ResourceDescription", "documentation": "Updates the description for the map resource.
" @@ -6351,7 +6386,7 @@ ], "members": { "IndexArn": { - "shape": "Arn", + "shape": "GeoArn", "documentation": "The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across Amazon Web Services.
Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex
The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.
Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator
The name of the application.
" }, + "roleArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the role associated with the application.
" + }, "status": { "shape": "ApplicationLifecycle", "documentation": "The status of the application.
" @@ -1247,7 +1251,7 @@ }, "Arn": { "type": "string", - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" }, "ArnList": { "type": "list", @@ -1305,7 +1309,8 @@ "documentation": "The unique identifier of the application that hosts this batch job.
" }, "batchJobIdentifier": { - "shape": "BatchJobIdentifier" + "shape": "BatchJobIdentifier", + "documentation": "The unique identifier of this batch job.
" }, "endTime": { "shape": "Timestamp", @@ -1329,7 +1334,7 @@ }, "returnCode": { "shape": "String", - "documentation": "" + "documentation": "The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
" }, "startTime": { "shape": "Timestamp", @@ -1385,7 +1390,7 @@ }, "BatchParamKey": { "type": "string", - "documentation": "Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.
", + "documentation": "See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc ...)
Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.
", "max": 8, "min": 1, "pattern": "^[A-Za-z][A-Za-z0-9]{1,7}$" @@ -1463,6 +1468,10 @@ "shape": "EntityName", "documentation": "The unique identifier of the application.
" }, + "roleArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the role associated with the application.
" + }, "tags": { "shape": "TagMap", "documentation": "A list of tags to apply to the application.
" @@ -1835,6 +1844,14 @@ "shape": "GdgDetailAttributes", "documentation": "The generation data group of the data set.
" }, + "po": { + "shape": "PoDetailAttributes", + "documentation": "The details of a PO type data set.
" + }, + "ps": { + "shape": "PsDetailAttributes", + "documentation": "The details of a PS type data set.
" + }, "vsam": { "shape": "VsamDetailAttributes", "documentation": "The details of a VSAM data set.
" @@ -1850,6 +1867,14 @@ "shape": "GdgAttributes", "documentation": "The generation data group of the data set.
" }, + "po": { + "shape": "PoAttributes", + "documentation": "The details of a PO type data set.
" + }, + "ps": { + "shape": "PsAttributes", + "documentation": "The details of a PS type data set.
" + }, "vsam": { "shape": "VsamAttributes", "documentation": "The details of a VSAM data set.
" @@ -2327,6 +2352,10 @@ "shape": "EntityName", "documentation": "The unique identifier of the application.
" }, + "roleArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the role associated with the application.
" + }, "status": { "shape": "ApplicationLifecycle", "documentation": "The status of the application.
" @@ -2441,7 +2470,8 @@ "documentation": "The identifier of the application.
" }, "batchJobIdentifier": { - "shape": "BatchJobIdentifier" + "shape": "BatchJobIdentifier", + "documentation": "The unique identifier of this batch job.
" }, "endTime": { "shape": "Timestamp", @@ -2469,7 +2499,7 @@ }, "returnCode": { "shape": "String", - "documentation": "" + "documentation": "The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
" }, "startTime": { "shape": "Timestamp", @@ -3316,6 +3346,46 @@ }, "documentation": "The scheduled maintenance for a runtime engine.
" }, + "PoAttributes": { + "type": "structure", + "required": [ + "format", + "memberFileExtensions" + ], + "members": { + "encoding": { + "shape": "String", + "documentation": "The character set encoding of the data set.
" + }, + "format": { + "shape": "String", + "documentation": "The format of the data set records.
" + }, + "memberFileExtensions": { + "shape": "String20List", + "documentation": "An array containing one or more filename extensions, allowing you to specify which files to be included as PDS member.
" + } + }, + "documentation": "The supported properties for a PO type data set.
" + }, + "PoDetailAttributes": { + "type": "structure", + "required": [ + "encoding", + "format" + ], + "members": { + "encoding": { + "shape": "String", + "documentation": "The character set encoding of the data set.
" + }, + "format": { + "shape": "String", + "documentation": "The format of the data set records.
" + } + }, + "documentation": "The supported properties for a PO type data set.
" + }, "PortList": { "type": "list", "member": { @@ -3345,6 +3415,41 @@ }, "documentation": "The primary key for a KSDS data set.
" }, + "PsAttributes": { + "type": "structure", + "required": [ + "format" + ], + "members": { + "encoding": { + "shape": "String", + "documentation": "The character set encoding of the data set.
" + }, + "format": { + "shape": "String", + "documentation": "The format of the data set records.
" + } + }, + "documentation": "The supported properties for a PS type data set.
" + }, + "PsDetailAttributes": { + "type": "structure", + "required": [ + "encoding", + "format" + ], + "members": { + "encoding": { + "shape": "String", + "documentation": "The character set encoding of the data set.
" + }, + "format": { + "shape": "String", + "documentation": "The format of the data set records.
" + } + }, + "documentation": "The supported properties for a PS type data set.
" + }, "RecordLength": { "type": "structure", "required": [ @@ -3504,6 +3609,14 @@ "type": "string", "pattern": "^\\S{1,2000}$" }, + "String20List": { + "type": "list", + "member": { + "shape": "String20" + }, + "max": 10, + "min": 1 + }, "String50": { "type": "string", "pattern": "^\\S{1,50}$" diff --git a/apis/memorydb-2021-01-01.normal.json b/apis/memorydb-2021-01-01.normal.json index a7823ffbd6..7b400c86f9 100644 --- a/apis/memorydb-2021-01-01.normal.json +++ b/apis/memorydb-2021-01-01.normal.json @@ -1393,7 +1393,8 @@ "type": "string", "enum": [ "password", - "no-password" + "no-password", + "iam" ] }, "AvailabilityZone": { @@ -2672,7 +2673,8 @@ "InputAuthenticationType": { "type": "string", "enum": [ - "password" + "password", + "iam" ] }, "Integer": { diff --git a/apis/metadata.json b/apis/metadata.json index be002cd46c..250bab12bd 100644 --- a/apis/metadata.json +++ b/apis/metadata.json @@ -974,7 +974,8 @@ "name": "SagemakerEdge" }, "amp": { - "name": "Amp" + "name": "Amp", + "cors": true }, "greengrassv2": { "name": "GreengrassV2" diff --git a/apis/mwaa-2020-07-01.normal.json b/apis/mwaa-2020-07-01.normal.json index 691b7c8338..ecb0f777fc 100644 --- a/apis/mwaa-2020-07-01.normal.json +++ b/apis/mwaa-2020-07-01.normal.json @@ -403,7 +403,7 @@ }, "AirflowVersion": { "shape": "AirflowVersion", - "documentation": "The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12
, 2.0.2
, 2.2.2
, and 2.4.3
. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12
, 2.0.2
, 2.2.2
, 2.4.3
, and 2.5.1
. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
The Apache Airflow version on your environment. Valid values: 1.10.12
, 2.0.2
, 2.2.2
, and 2.4.3
.
The Apache Airflow version on your environment. Valid values: 1.10.12
, 2.0.2
, 2.2.2
, 2.4.3
, and 2.5.1
.
The status of the Amazon MWAA environment. Valid values:
CREATING
- Indicates the request to create the environment is in progress.
CREATE_FAILED
- Indicates the request to create the environment failed, and the environment could not be created.
AVAILABLE
- Indicates the request was successful and the environment is ready to use.
UPDATING
- Indicates the request to update the environment is in progress.
DELETING
- Indicates the request to delete the environment is in progress.
DELETED
- Indicates the request to delete the environment is complete, and the environment has been deleted.
UNAVAILABLE
- Indicates the request failed, but the environment was unable to rollback and is not in a stable state.
UPDATE_FAILED
- Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
" + "documentation": "The status of the Amazon MWAA environment. Valid values:
CREATING
- Indicates the request to create the environment is in progress.
CREATING_SNAPSHOT
- Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.
CREATE_FAILED
- Indicates the request to create the environment failed, and the environment could not be created.
AVAILABLE
- Indicates the request was successful and the environment is ready to use.
UPDATING
- Indicates the request to update the environment is in progress.
ROLLING_BACK
- Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
DELETING
- Indicates the request to delete the environment is in progress.
DELETED
- Indicates the request to delete the environment is complete, and the environment has been deleted.
UNAVAILABLE
- Indicates the request failed, but the environment was unable to rollback and is not in a stable state.
UPDATE_FAILED
- Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
" }, "Tags": { "shape": "TagMap", @@ -726,7 +726,9 @@ "DELETING", "DELETED", "UNAVAILABLE", - "UPDATE_FAILED" + "UPDATE_FAILED", + "ROLLING_BACK", + "CREATING_SNAPSHOT" ] }, "ErrorCode": { @@ -1269,7 +1271,7 @@ }, "AirflowVersion": { "shape": "AirflowVersion", - "documentation": "The Apache Airflow version for your environment. If no value is specified, defaults to the latest version. Valid values: 1.10.12
, 2.0.2
, 2.2.2
, and 2.4.3
.
The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.
Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading an Amazon MWAA environment.
Valid values: 1.10.12
, 2.0.2
, 2.2.2
, 2.4.3
, and 2.5.1
.
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.
Endpoints
api.airflow.{region}.amazonaws.com
- This endpoint is used for environment management.
env.airflow.{region}.amazonaws.com
- This endpoint is used to operate the Airflow environment.
ops.airflow.{region}.amazonaws.com
- This endpoint is used to push environment metrics that track environment health.
Regions
For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.
" + "documentation": "This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What is Amazon MWAA?.
Endpoints
api.airflow.{region}.amazonaws.com
- This endpoint is used for environment management.
env.airflow.{region}.amazonaws.com
- This endpoint is used to operate the Airflow environment.
ops.airflow.{region}.amazonaws.com
- This endpoint is used to push environment metrics that track environment health.
Regions
For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.
" } \ No newline at end of file diff --git a/apis/personalize-2018-05-22.min.json b/apis/personalize-2018-05-22.min.json index f9e332ee8d..23410144eb 100644 --- a/apis/personalize-2018-05-22.min.json +++ b/apis/personalize-2018-05-22.min.json @@ -375,7 +375,7 @@ "datasetGroupArn": {}, "eventType": {}, "solutionConfig": { - "shape": "S1t" + "shape": "S1x" }, "tags": { "shape": "Sf" @@ -595,7 +595,7 @@ "members": { "name": {}, "values": { - "shape": "S2c" + "shape": "S2g" }, "isTunable": { "type": "boolean" @@ -1146,7 +1146,7 @@ } }, "modelMetrics": { - "shape": "S4o" + "shape": "S4s" } } } @@ -1214,7 +1214,7 @@ "datasetGroupArn": {}, "eventType": {}, "solutionConfig": { - "shape": "S1t" + "shape": "S1x" }, "autoMLResult": { "type": "structure", @@ -1230,7 +1230,7 @@ "type": "timestamp" }, "latestSolutionVersion": { - "shape": "S4y" + "shape": "S52" } } } @@ -1267,7 +1267,7 @@ "eventType": {}, "datasetGroupArn": {}, "solutionConfig": { - "shape": "S1t" + "shape": "S1x" }, "trainingHours": { "type": "double" @@ -1310,7 +1310,7 @@ "members": { "solutionVersionArn": {}, "metrics": { - "shape": "S4o" + "shape": "S4s" } } } @@ -1841,7 +1841,7 @@ "solutionVersions": { "type": "list", "member": { - "shape": "S4y" + "shape": "S52" } }, "nextToken": {} @@ -2211,10 +2211,26 @@ }, "minRecommendationRequestsPerSecond": { "type": "integer" + }, + "trainingDataConfig": { + "shape": "S1n" + } + } + }, + "S1n": { + "type": "structure", + "members": { + "excludedDatasetColumns": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } } } }, - "S1t": { + "S1x": { "type": "structure", "members": { "eventValueThreshold": {}, @@ -2276,7 +2292,7 @@ "members": { "name": {}, "values": { - "shape": "S2c" + "shape": "S2g" } } } @@ -2309,21 +2325,24 @@ "itemAttribute": {}, "objectiveSensitivity": {} } + }, + "trainingDataConfig": { + "shape": "S1n" } } }, - "S2c": { + "S2g": { "type": "list", "member": {} }, - "S4o": { + "S4s": { "type": "map", "key": {}, "value": { "type": "double" } }, - "S4y": { + "S52": { "type": "structure", "members": { "solutionVersionArn": {}, diff --git a/apis/personalize-2018-05-22.normal.json b/apis/personalize-2018-05-22.normal.json index bf65980043..1905fa8c68 100644 --- a/apis/personalize-2018-05-22.normal.json +++ b/apis/personalize-2018-05-22.normal.json @@ -113,7 +113,7 @@ "shape": "TooManyTagsException" } ], - "documentation": "Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A transaction is a single GetRecommendations
or GetPersonalizedRanking
call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS
) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS
, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS
. There's a short time delay while the capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS
, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS
as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status
of the campaign is ACTIVE
before asking the campaign for recommendations.
Related APIs
", + "documentation": "Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A high minProvisionedTPS
will increase your bill. We recommend starting with 1 for minProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS
as necessary.
A transaction is a single GetRecommendations
or GetPersonalizedRanking
call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS
) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS
, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS
. There's a short time delay while the capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS
, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS
as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status
of the campaign is ACTIVE
before asking the campaign for recommendations.
Related APIs
", "idempotent": true }, "CreateDataset": { @@ -377,7 +377,7 @@ "shape": "TooManyTagsException" } ], - "documentation": "Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond
) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1
. A recommendation request is a single GetRecommendations
operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.
If your requests per second increases beyond minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond
. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond
, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
as necessary.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status
of the recommender is ACTIVE
before asking the recommender for recommendations.
Related APIs
", + "documentation": "Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
A high minRecommendationRequestsPerSecond
will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond
(the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond
as necessary.
When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond
) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1
. A recommendation request is a single GetRecommendations
operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.
If your requests per second increases beyond minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond
. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond
, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
as necessary.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status
of the recommender is ACTIVE
before asking the recommender for recommendations.
Related APIs
", "idempotent": true }, "CreateSchema": { @@ -438,7 +438,7 @@ "shape": "TooManyTagsException" } ], - "documentation": "Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion
, a new version of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML
and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.
Amazon Personalize doesn't support configuring the hpoObjective
for solution hyperparameter optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion
.
Related APIs
" + "documentation": "Creates the configuration for training a model. A trained model is known as a solution version. After the configuration is created, you train the model (create a solution version) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion
, a new version of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize.
Amazon Personalize doesn't support configuring the hpoObjective
for solution hyperparameter optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion
.
Related APIs
" }, "CreateSolutionVersion": { "name": "CreateSolutionVersion", @@ -1483,7 +1483,7 @@ "shape": "ResourceInUseException" } ], - "documentation": "Get a list of tags attached to a resource.
" + "documentation": "Get a list of tags attached to a resource.
" }, "StartRecommender": { "name": "StartRecommender", @@ -1617,7 +1617,7 @@ "shape": "ResourceInUseException" } ], - "documentation": "Remove tags that are attached to a resource.
" + "documentation": "Remove tags that are attached to a resource.
" }, "UpdateCampaign": { "name": "UpdateCampaign", @@ -1696,7 +1696,7 @@ "shape": "ResourceInUseException" } ], - "documentation": "Updates the recommender to modify the recommender configuration.
", + "documentation": "Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate
returned in the DescribeRecommender operation.
The number of predicted users generated by the batch segment job for each line of input data.
" + "documentation": "The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
" }, "jobInput": { "shape": "BatchSegmentJobInput", @@ -2082,7 +2082,7 @@ }, "minProvisionedTPS": { "shape": "TransactionsPerSecond", - "documentation": "Specifies the requested minimum provisioned transactions (recommendations) per second.
" + "documentation": "Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS
will increase your bill. We recommend starting with 1 for minProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS
as necessary.
A list of tags to apply to the batch inference job.
" + "documentation": "A list of tags to apply to the batch inference job.
" } } }, @@ -2336,7 +2347,7 @@ }, "numResults": { "shape": "NumBatchResults", - "documentation": "The number of predicted users generated by the batch segment job for each line of input data.
" + "documentation": "The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
" }, "jobInput": { "shape": "BatchSegmentJobInput", @@ -2352,7 +2363,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the batch segment job.
" + "documentation": "A list of tags to apply to the batch segment job.
" } } }, @@ -2382,7 +2393,7 @@ }, "minProvisionedTPS": { "shape": "TransactionsPerSecond", - "documentation": "Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
" + "documentation": "Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS
will increase your bill. We recommend starting with 1 for minProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS
as necessary.
A list of tags to apply to the campaign.
" + "documentation": "A list of tags to apply to the campaign.
" } } }, @@ -2434,7 +2445,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the dataset export job.
" + "documentation": "A list of tags to apply to the dataset export job.
" } } }, @@ -2471,7 +2482,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the dataset group.
" + "documentation": "A list of tags to apply to the dataset group.
" } } }, @@ -2515,7 +2526,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the dataset import job.
" + "documentation": "A list of tags to apply to the dataset import job.
" }, "importMode": { "shape": "ImportMode", @@ -2563,7 +2574,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the dataset.
" + "documentation": "A list of tags to apply to the dataset.
" } } }, @@ -2593,7 +2604,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the event tracker.
" + "documentation": "A list of tags to apply to the event tracker.
" } } }, @@ -2632,7 +2643,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the filter.
" + "documentation": "A list of tags to apply to the filter.
" } } }, @@ -2707,7 +2718,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the recommender.
" + "documentation": "A list of tags to apply to the recommender.
" } } }, @@ -2767,7 +2778,7 @@ }, "performAutoML": { "shape": "PerformAutoML", - "documentation": "Whether to perform automated machine learning (AutoML). The default is false
. For this case, you must specify recipeArn
.
When set to true
, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.
Whether to perform automated machine learning (AutoML). The default is false
. For this case, you must specify recipeArn
.
When set to true
, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
A list of tags to apply to the solution.
" + "documentation": "A list of tags to apply to the solution.
" } } }, @@ -2820,7 +2831,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of tags to apply to the solution version.
" + "documentation": "A list of tags to apply to the solution version.
" } } }, @@ -3909,6 +3920,16 @@ "type": "string", "max": 256 }, + "ExcludedDatasetColumns": { + "type": "map", + "key": { + "shape": "DatasetType" + }, + "value": { + "shape": "ColumnNamesList" + }, + "max": 3 + }, "FailureReason": { "type": "string" }, @@ -5069,7 +5090,11 @@ }, "minRecommendationRequestsPerSecond": { "shape": "TransactionsPerSecond", - "documentation": "Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
" + "documentation": "Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond
will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond
(the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond
as necessary.
Specifies the training data configuration to use when creating a domain recommender.
" } }, "documentation": "The configuration details of the recommender.
" @@ -5206,7 +5231,7 @@ }, "performAutoML": { "shape": "PerformAutoML", - "documentation": "When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn
must not be specified). When false (the default), Amazon Personalize uses recipeArn
for training.
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn
must not be specified). When false (the default), Amazon Personalize uses recipeArn
for training.
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
" + }, + "trainingDataConfig": { + "shape": "TrainingDataConfig", + "documentation": "Specifies the training data configuration to use when creating a custom solution version (trained model).
" } }, "documentation": "Describes the configuration properties for the solution.
" @@ -5491,7 +5520,7 @@ "documentation": "The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
" } }, - "documentation": "The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
" + "documentation": "The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize recources.
" }, "TagKey": { "type": "string", @@ -5520,7 +5549,7 @@ }, "tags": { "shape": "Tags", - "documentation": "Tags to apply to the resource. For more information see Tagging Personalize resources.
" + "documentation": "Tags to apply to the resource. For more information see Tagging Amazon Personalize recources.
" } } }, @@ -5546,6 +5575,16 @@ "type": "string", "max": 256 }, + "TrainingDataConfig": { + "type": "structure", + "members": { + "excludedDatasetColumns": { + "shape": "ExcludedDatasetColumns", + "documentation": "Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations. For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.
" + } + }, + "documentation": "The training data configuration to use when creating a domain recommender or custom solution version (trained model).
" + }, "TrainingHours": { "type": "double", "min": 0 @@ -5615,7 +5654,7 @@ }, "minProvisionedTPS": { "shape": "TransactionsPerSecond", - "documentation": "Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
" + "documentation": "Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS
will increase your bill. We recommend starting with 1 for minProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS
as necessary.
Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "documentation": "Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
For more information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For more information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
" }, "Iops": { "shape": "IntegerOptional", @@ -11218,6 +11218,10 @@ "MasterUserSecretKmsKeyId": { "shape": "String", "documentation": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
" + }, + "Engine": { + "shape": "String", + "documentation": "The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with --db-parameter-group-name
and a new option group with --option-group-name
.
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46
(supported for 5.1 DB snapshots)
Oracle
19.0.0.0.ru-2022-01.rur-2022-01.r1
(supported for 12.2.0.1 DB snapshots)
19.0.0.0.ru-2022-07.rur-2022-07.r1
(supported for 12.1.0.2 DB snapshots)
12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12
(supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11
(supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
" + "documentation": "The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46
(supported for 5.1 DB snapshots)
Oracle
12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12
(supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11
(supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
" }, "OptionGroupName": { "shape": "String", @@ -12358,6 +12362,10 @@ "StorageThroughput": { "shape": "IntegerOptional", "documentation": "The storage throughput of the DB instance.
" + }, + "Engine": { + "shape": "String", + "documentation": "The database engine of the DB instance.
" } }, "documentation": "This data type is used as a response element in the ModifyDBInstance
operation and contains changes that will be applied during the next maintenance window.
Status of the deployment recommendation. NOT_APPLICABLE
means that SageMaker is unable to provide a default recommendation for the model using the information provided.
Status of the deployment recommendation. The status NOT_APPLICABLE
means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS
, retry your API call after a few seconds to get a COMPLETED
deployment recommendation.
A list of RealTimeInferenceRecommendation items.
" } }, - "documentation": "A set of recommended deployment configurations for the model.
" + "documentation": "A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.
" }, "DeploymentStage": { "type": "structure", @@ -16034,6 +16034,10 @@ "ParallelismConfiguration": { "shape": "ParallelismConfiguration", "documentation": "The parallelism configuration applied to the pipeline.
" + }, + "SelectiveExecutionConfig": { + "shape": "SelectiveExecutionConfig", + "documentation": "The selective execution configuration applied to the pipeline run.
" } } }, @@ -29746,6 +29750,10 @@ "PipelineParameters": { "shape": "ParameterList", "documentation": "Contains a list of pipeline parameters. This list can be empty.
" + }, + "SelectiveExecutionConfig": { + "shape": "SelectiveExecutionConfig", + "documentation": "The selective execution configuration applied to the pipeline run.
" } }, "documentation": "An execution of a pipeline.
" @@ -29824,6 +29832,10 @@ "Metadata": { "shape": "PipelineExecutionStepMetadata", "documentation": "Metadata to run the pipeline step.
" + }, + "SelectiveExecutionResult": { + "shape": "SelectiveExecutionResult", + "documentation": "The ARN from an execution of the current pipeline from which results are reused for this step.
" } }, "documentation": "An execution of a step in a pipeline.
" @@ -31546,7 +31558,7 @@ "documentation": "The level of permissions that the user has within the RStudioServerPro
app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.
A collection of settings that configure user interaction with the RStudioServerPro
app. RStudioServerProAppSettings
cannot be updated. The RStudioServerPro
app must be deleted and a new one created to make any changes.
A collection of settings that configure user interaction with the RStudioServerPro
app.
The name of the pipeline step.
" + } + }, + "documentation": "A step selected to run in selective execution mode.
" + }, + "SelectedStepList": { + "type": "list", + "member": { + "shape": "SelectedStep" + }, + "max": 50, + "min": 1 + }, + "SelectiveExecutionConfig": { + "type": "structure", + "required": [ + "SourcePipelineExecutionArn", + "SelectedSteps" + ], + "members": { + "SourcePipelineExecutionArn": { + "shape": "PipelineExecutionArn", + "documentation": "The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed
or Success
.
A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
" + } + }, + "documentation": "The selective execution configuration applied to the pipeline run.
" + }, + "SelectiveExecutionResult": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "shape": "PipelineExecutionArn", + "documentation": "The ARN from an execution of the current pipeline.
" + } + }, + "documentation": "The ARN from an execution of the current pipeline.
" + }, "SendPipelineExecutionStepFailureRequest": { "type": "structure", "required": [ @@ -33435,6 +33496,10 @@ "ParallelismConfiguration": { "shape": "ParallelismConfiguration", "documentation": "This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
" + }, + "SelectiveExecutionConfig": { + "shape": "SelectiveExecutionConfig", + "documentation": "The selective execution configuration applied to the pipeline run.
" } } }, diff --git a/apis/securityhub-2018-10-26.examples.json b/apis/securityhub-2018-10-26.examples.json index a698dfa3bb..df1fd0c5de 100644 --- a/apis/securityhub-2018-10-26.examples.json +++ b/apis/securityhub-2018-10-26.examples.json @@ -73,9 +73,103 @@ "output": { } }, - "description": "The following example imports findings from a third party provider to Security Hub.", - "id": "to-import-security-findings-from-a-third-party-provider-to-security-hub-1675090935260", - "title": "To import security findings from a third party provider to Security Hub" + "description": "The following example enables the security standard specified by the StandardArn. You can use this operation to enable one or more Security Hub standards.", + "id": "to-enable-security-standards-1683233792239", + "title": "To enable security standards" + } + ], + "BatchGetSecurityControls": [ + { + "input": { + "SecurityControlIds": [ + "ACM.1", + "APIGateway.1" + ] + }, + "output": { + "SecurityControls": [ + { + "Description": "This AWS control checks whether ACM Certificates in your account are marked for expiration within a specified time period. Certificates provided by ACM are automatically renewed. ACM does not automatically renew certificates that you import.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation", + "SecurityControlArn": "arn:aws:securityhub:us-west-2:123456789012:security-control/ACM.1", + "SecurityControlId": "ACM.1", + "SecurityControlStatus": "ENABLED", + "SeverityRating": "MEDIUM", + "Title": "Imported and ACM-issued certificates should be renewed after a specified time period" + }, + { + "Description": "This control checks whether all stages of Amazon API Gateway REST and WebSocket APIs have logging enabled. The control fails if logging is not enabled for all methods of a stage or if loggingLevel is neither ERROR nor INFO.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.1/remediation", + "SecurityControlArn": "arn:aws:securityhub:us-west-2:123456789012:security-control/APIGateway.1", + "SecurityControlId": "APIGateway.1", + "SecurityControlStatus": "ENABLED", + "SeverityRating": "MEDIUM", + "Title": "API Gateway REST and WebSocket API execution logging should be enabled" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets details for the specified controls in the current AWS account and AWS Region.", + "id": "to-get-security-control-details--1683234478355", + "title": "To get security control details " + } + ], + "BatchGetStandardsControlAssociations": [ + { + "input": { + "StandardsControlAssociationIds": [ + { + "SecurityControlId": "CloudTrail.1", + "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + }, + { + "SecurityControlId": "CloudWatch.12", + "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + } + ] + }, + "output": { + "StandardsControlAssociationDetails": [ + { + "AssociationStatus": "ENABLED", + "RelatedRequirements": [ + "CIS AWS Foundations 2.1" + ], + "SecurityControlArn": "arn:aws:securityhub:us-west-2:110479873537:security-control/CloudTrail.1", + "SecurityControlId": "CloudTrail.1", + "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0", + "StandardsControlDescription": "AWS CloudTrail is a web service that records AWS API calls for your account and delivers log files to you. The recorded information includes the identity of the API caller, the time of the API call, the source IP address of the API caller, the request parameters, and the response elements returned by the AWS service.", + "StandardsControlTitle": "Ensure CloudTrail is enabled in all regions", + "UpdatedAt": "2022-01-13T18:52:29.539000+00:00" + }, + { + "AssociationStatus": "ENABLED", + "RelatedRequirements": [ + "CIS AWS Foundations 3.12" + ], + "SecurityControlArn": "arn:aws:securityhub:us-west-2:110479873537:security-control/CloudWatch.12", + "SecurityControlId": "CloudWatch.12", + "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0", + "StandardsControlDescription": "Real-time monitoring of API calls can be achieved by directing CloudTrail Logs to CloudWatch Logs and establishing corresponding metric filters and alarms. Network gateways are required to send/receive traffic to a destination outside of a VPC. It is recommended that a metric filter and alarm be established for changes to network gateways.", + "StandardsControlTitle": "Ensure a log metric filter and alarm exist for changes to network gateways", + "UpdatedAt": "2022-01-13T18:52:29.686000+00:00" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves the enablement status of the specified controls in the specified standards.", + "id": "to-get-enablement-status-of-a-batch-of-controls-1683301618357", + "title": "To get enablement status of a batch of controls" } ], "BatchImportFindings": [ @@ -195,6 +289,49 @@ "title": "To update Security Hub findings" } ], + "BatchUpdateStandardsControlAssociations": [ + { + "input": { + "StandardsControlAssociationUpdates": [ + { + "AssociationStatus": "DISABLED", + "SecurityControlId": "CloudTrail.1", + "StandardsArn": "arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0", + "UpdatedReason": "Not relevant to environment" + }, + { + "AssociationStatus": "DISABLED", + "SecurityControlId": "CloudWatch.12", + "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0", + "UpdatedReason": "Not relevant to environment" + } + ] + }, + "output": { + "UnprocessedAssociationUpdates": [ + { + "ErrorCode": "INVALID_INPUT", + "ErrorReason": "Invalid Standards Arn: 'arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0'", + "StandardsControlAssociationUpdate": { + "AssociationStatus": "DISABLED", + "SecurityControlId": "CloudTrail.1", + "StandardsArn": "arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0", + "UpdatedReason": "Test Reason" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example disables CloudWatch.12 in CIS AWS Foundations Benchmark v1.2.0. The example returns an error for CloudTrail.1 because an invalid standard ARN is provided.", + "id": "to-update-enablement-status-of-a-batch-of-controls-1683300378416", + "title": "To update enablement status of a batch of controls" + } + ], "CreateActionTarget": [ { "input": { diff --git a/apis/securityhub-2018-10-26.min.json b/apis/securityhub-2018-10-26.min.json index 8d0bc7fe35..2184303785 100644 --- a/apis/securityhub-2018-10-26.min.json +++ b/apis/securityhub-2018-10-26.min.json @@ -314,10 +314,10 @@ ], "members": { "FindingIdentifiers": { - "shape": "Slj" + "shape": "Smi" }, "Note": { - "shape": "Sll" + "shape": "Smk" }, "Severity": { "type": "structure", @@ -351,7 +351,7 @@ } }, "RelatedFindings": { - "shape": "Ski" + "shape": "Slh" } } }, @@ -363,7 +363,7 @@ ], "members": { "ProcessedFindings": { - "shape": "Slj" + "shape": "Smi" }, "UnprocessedFindings": { "type": "list", @@ -376,7 +376,7 @@ ], "members": { "FindingIdentifier": { - "shape": "Slk" + "shape": "Smj" }, "ErrorCode": {}, "ErrorMessage": {} @@ -400,7 +400,7 @@ "StandardsControlAssociationUpdates": { "type": "list", "member": { - "shape": "Slt" + "shape": "Sms" } } } @@ -418,7 +418,7 @@ ], "members": { "StandardsControlAssociationUpdate": { - "shape": "Slt" + "shape": "Sms" }, "ErrorCode": {}, "ErrorReason": {} @@ -497,7 +497,7 @@ "members": { "Name": {}, "Filters": { - "shape": "Sm2" + "shape": "Sn1" }, "GroupByAttribute": {} } @@ -541,7 +541,7 @@ "type": "structure", "members": { "UnprocessedAccounts": { - "shape": "Smr" + "shape": "Snq" } } } @@ -557,7 +557,7 @@ ], "members": { "AccountIds": { - "shape": "Smu" + "shape": "Snt" } } }, @@ -565,7 +565,7 @@ "type": "structure", "members": { "UnprocessedAccounts": { - "shape": "Smr" + "shape": "Snq" } } } @@ -657,7 +657,7 @@ ], "members": { "AccountIds": { - "shape": "Smu" + "shape": "Snt" } } }, @@ -665,7 +665,7 @@ "type": "structure", "members": { "UnprocessedAccounts": { - "shape": "Smr" + "shape": "Snq" } } } @@ -681,7 +681,7 @@ ], "members": { "AccountIds": { - "shape": "Smu" + "shape": "Snt" } } }, @@ -689,7 +689,7 @@ "type": "structure", "members": { "UnprocessedAccounts": { - "shape": "Smr" + "shape": "Snq" } } } @@ -702,7 +702,7 @@ "type": "structure", "members": { "ActionTargetArns": { - "shape": "Sn7" + "shape": "So6" }, "NextToken": {}, "MaxResults": { @@ -1038,7 +1038,7 @@ ], "members": { "AccountIds": { - "shape": "Smu" + "shape": "Snt" } } }, @@ -1093,7 +1093,7 @@ "type": "structure", "members": { "Tags": { - "shape": "Sog" + "shape": "Spf" }, "EnableDefaultStandards": { "type": "boolean" @@ -1119,7 +1119,7 @@ "type": "structure", "members": { "Administrator": { - "shape": "Som" + "shape": "Spl" } } } @@ -1190,7 +1190,7 @@ ], "members": { "FindingIdentifier": { - "shape": "Slk" + "shape": "Smj" }, "StartTime": { "shape": "S11" @@ -1213,7 +1213,7 @@ "type": "structure", "members": { "FindingIdentifier": { - "shape": "Slk" + "shape": "Smj" }, "UpdateTime": { "shape": "S11" @@ -1255,7 +1255,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sm2" + "shape": "Sn1" }, "SortCriteria": { "type": "list", @@ -1351,7 +1351,7 @@ "type": "structure", "members": { "InsightArns": { - "shape": "Sn7" + "shape": "So6" }, "NextToken": {}, "MaxResults": { @@ -1379,7 +1379,7 @@ "InsightArn": {}, "Name": {}, "Filters": { - "shape": "Sm2" + "shape": "Sn1" }, "GroupByAttribute": {} } @@ -1420,7 +1420,7 @@ "type": "structure", "members": { "Master": { - "shape": "Som" + "shape": "Spl" } } }, @@ -1438,7 +1438,7 @@ ], "members": { "AccountIds": { - "shape": "Smu" + "shape": "Snt" } } }, @@ -1446,10 +1446,10 @@ "type": "structure", "members": { "Members": { - "shape": "Spk" + "shape": "Sqj" }, "UnprocessedAccounts": { - "shape": "Smr" + "shape": "Snq" } } } @@ -1465,7 +1465,7 @@ ], "members": { "AccountIds": { - "shape": "Smu" + "shape": "Snt" } } }, @@ -1473,7 +1473,7 @@ "type": "structure", "members": { "UnprocessedAccounts": { - "shape": "Smr" + "shape": "Snq" } } } @@ -1568,7 +1568,7 @@ "Invitations": { "type": "list", "member": { - "shape": "Som" + "shape": "Spl" } }, "NextToken": {} @@ -1603,7 +1603,7 @@ "type": "structure", "members": { "Members": { - "shape": "Spk" + "shape": "Sqj" }, "NextToken": {} } @@ -1784,7 +1784,7 @@ "type": "structure", "members": { "Tags": { - "shape": "Sog" + "shape": "Spf" } } } @@ -1805,7 +1805,7 @@ "locationName": "ResourceArn" }, "Tags": { - "shape": "Sog" + "shape": "Spf" } } }, @@ -1910,10 +1910,10 @@ ], "members": { "Filters": { - "shape": "Sm2" + "shape": "Sn1" }, "Note": { - "shape": "Sll" + "shape": "Smk" }, "RecordState": {} } @@ -1940,7 +1940,7 @@ }, "Name": {}, "Filters": { - "shape": "Sm2" + "shape": "Sn1" }, "GroupByAttribute": {} } @@ -7626,6 +7626,281 @@ }, "VpcId": {} } + }, + "AwsAmazonMqBroker": { + "type": "structure", + "members": { + "AuthenticationStrategy": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "BrokerArn": {}, + "BrokerName": {}, + "DeploymentMode": {}, + "EncryptionOptions": { + "type": "structure", + "members": { + "KmsKeyId": {}, + "UseAwsOwnedKey": { + "type": "boolean" + } + } + }, + "EngineType": {}, + "EngineVersion": {}, + "HostInstanceType": {}, + "BrokerId": {}, + "LdapServerMetadata": { + "type": "structure", + "members": { + "Hosts": { + "shape": "Sk" + }, + "RoleBase": {}, + "RoleName": {}, + "RoleSearchMatching": {}, + "RoleSearchSubtree": { + "type": "boolean" + }, + "ServiceAccountUsername": {}, + "UserBase": {}, + "UserRoleName": {}, + "UserSearchMatching": {}, + "UserSearchSubtree": { + "type": "boolean" + } + } + }, + "Logs": { + "type": "structure", + "members": { + "Audit": { + "type": "boolean" + }, + "General": { + "type": "boolean" + }, + "AuditLogGroup": {}, + "GeneralLogGroup": {}, + "Pending": { + "type": "structure", + "members": { + "Audit": { + "type": "boolean" + }, + "General": { + "type": "boolean" + } + } + } + } + }, + "MaintenanceWindowStartTime": { + "type": "structure", + "members": { + "DayOfWeek": {}, + "TimeOfDay": {}, + "TimeZone": {} + } + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "SecurityGroups": { + "shape": "Sk" + }, + "StorageType": {}, + "SubnetIds": { + "shape": "Sk" + }, + "Users": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PendingChange": {}, + "Username": {} + } + } + } + } + }, + "AwsAppSyncGraphQlApi": { + "type": "structure", + "members": { + "ApiId": {}, + "Id": {}, + "OpenIdConnectConfig": { + "shape": "Skg" + }, + "Name": {}, + "LambdaAuthorizerConfig": { + "shape": "Skh" + }, + "XrayEnabled": { + "type": "boolean" + }, + "Arn": {}, + "UserPoolConfig": { + "shape": "Ski" + }, + "AuthenticationType": {}, + "LogConfig": { + "type": "structure", + "members": { + "CloudWatchLogsRoleArn": {}, + "ExcludeVerboseContent": { + "type": "boolean" + }, + "FieldLogLevel": {} + } + }, + "AdditionalAuthenticationProviders": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AuthenticationType": {}, + "LambdaAuthorizerConfig": { + "shape": "Skh" + }, + "OpenIdConnectConfig": { + "shape": "Skg" + }, + "UserPoolConfig": { + "shape": "Ski" + } + } + } + }, + "WafWebAclArn": {} + } + }, + "AwsEventSchemasRegistry": { + "type": "structure", + "members": { + "Description": {}, + "RegistryArn": {}, + "RegistryName": {} + } + }, + "AwsGuardDutyDetector": { + "type": "structure", + "members": { + "DataSources": { + "type": "structure", + "members": { + "CloudTrail": { + "type": "structure", + "members": { + "Status": {} + } + }, + "DnsLogs": { + "type": "structure", + "members": { + "Status": {} + } + }, + "FlowLogs": { + "type": "structure", + "members": { + "Status": {} + } + }, + "Kubernetes": { + "type": "structure", + "members": { + "AuditLogs": { + "type": "structure", + "members": { + "Status": {} + } + } + } + }, + "MalwareProtection": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "type": "structure", + "members": { + "Reason": {}, + "Status": {} + } + } + } + }, + "ServiceRole": {} + } + }, + "S3Logs": { + "type": "structure", + "members": { + "Status": {} + } + } + } + }, + "Features": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Status": {} + } + } + }, + "FindingPublishingFrequency": {}, + "ServiceRole": {}, + "Status": {} + } + }, + "AwsStepFunctionStateMachine": { + "type": "structure", + "members": { + "Label": {}, + "LoggingConfiguration": { + "type": "structure", + "members": { + "Destinations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroup": { + "type": "structure", + "members": { + "LogGroupArn": {} + } + } + } + } + }, + "IncludeExecutionData": { + "type": "boolean" + }, + "Level": {} + } + }, + "Name": {}, + "RoleArn": {}, + "StateMachineArn": {}, + "Status": {}, + "TracingConfiguration": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "Type": {} + } } } } @@ -7678,7 +7953,7 @@ }, "RecordState": {}, "RelatedFindings": { - "shape": "Ski" + "shape": "Slh" }, "Note": { "type": "structure", @@ -7808,7 +8083,7 @@ "members": { "ConnectionDirection": {}, "RemoteIpDetails": { - "shape": "Sky" + "shape": "Slx" }, "RemotePortDetails": { "type": "structure", @@ -7820,7 +8095,7 @@ } }, "LocalPortDetails": { - "shape": "Sl4" + "shape": "Sm3" }, "Protocol": {}, "Blocked": { @@ -7835,7 +8110,7 @@ "ServiceName": {}, "CallerType": {}, "RemoteIpDetails": { - "shape": "Sky" + "shape": "Slx" }, "DomainDetails": { "type": "structure", @@ -7869,7 +8144,7 @@ "type": "structure", "members": { "LocalPortDetails": { - "shape": "Sl4" + "shape": "Sm3" }, "LocalIpDetails": { "type": "structure", @@ -7878,7 +8153,7 @@ } }, "RemoteIpDetails": { - "shape": "Sky" + "shape": "Slx" } } } @@ -7900,7 +8175,7 @@ "type": "integer" }, "RelatedFindings": { - "shape": "Ski" + "shape": "Slh" }, "Severity": { "type": "structure", @@ -8513,7 +8788,39 @@ } } }, + "Skg": { + "type": "structure", + "members": { + "AuthTtL": { + "type": "long" + }, + "ClientId": {}, + "IatTtL": { + "type": "long" + }, + "Issuer": {} + } + }, + "Skh": { + "type": "structure", + "members": { + "AuthorizerResultTtlInSeconds": { + "type": "integer" + }, + "AuthorizerUri": {}, + "IdentityValidationExpression": {} + } + }, "Ski": { + "type": "structure", + "members": { + "AppIdClientRegex": {}, + "AwsRegion": {}, + "DefaultAction": {}, + "UserPoolId": {} + } + }, + "Slh": { "type": "list", "member": { "type": "structure", @@ -8527,7 +8834,7 @@ } } }, - "Sky": { + "Slx": { "type": "structure", "members": { "IpAddressV4": {}, @@ -8568,7 +8875,7 @@ } } }, - "Sl4": { + "Sm3": { "type": "structure", "members": { "Port": { @@ -8577,13 +8884,13 @@ "PortName": {} } }, - "Slj": { + "Smi": { "type": "list", "member": { - "shape": "Slk" + "shape": "Smj" } }, - "Slk": { + "Smj": { "type": "structure", "required": [ "Id", @@ -8594,7 +8901,7 @@ "ProductArn": {} } }, - "Sll": { + "Smk": { "type": "structure", "required": [ "Text", @@ -8605,7 +8912,7 @@ "UpdatedBy": {} } }, - "Slt": { + "Sms": { "type": "structure", "required": [ "StandardsArn", @@ -8619,272 +8926,272 @@ "UpdatedReason": {} } }, - "Sm2": { + "Sn1": { "type": "structure", "members": { "ProductArn": { - "shape": "Sm3" + "shape": "Sn2" }, "AwsAccountId": { - "shape": "Sm3" + "shape": "Sn2" }, "Id": { - "shape": "Sm3" + "shape": "Sn2" }, "GeneratorId": { - "shape": "Sm3" + "shape": "Sn2" }, "Region": { - "shape": "Sm3" + "shape": "Sn2" }, "Type": { - "shape": "Sm3" + "shape": "Sn2" }, "FirstObservedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "LastObservedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "CreatedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "UpdatedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "SeverityProduct": { - "shape": "Sma", + "shape": "Sn9", "deprecated": true, "deprecatedMessage": "This filter is deprecated. Instead, use FindingProviderSeverityOriginal." }, "SeverityNormalized": { - "shape": "Sma", + "shape": "Sn9", "deprecated": true, "deprecatedMessage": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." }, "SeverityLabel": { - "shape": "Sm3" + "shape": "Sn2" }, "Confidence": { - "shape": "Sma" + "shape": "Sn9" }, "Criticality": { - "shape": "Sma" + "shape": "Sn9" }, "Title": { - "shape": "Sm3" + "shape": "Sn2" }, "Description": { - "shape": "Sm3" + "shape": "Sn2" }, "RecommendationText": { - "shape": "Sm3" + "shape": "Sn2" }, "SourceUrl": { - "shape": "Sm3" + "shape": "Sn2" }, "ProductFields": { - "shape": "Smc" + "shape": "Snb" }, "ProductName": { - "shape": "Sm3" + "shape": "Sn2" }, "CompanyName": { - "shape": "Sm3" + "shape": "Sn2" }, "UserDefinedFields": { - "shape": "Smc" + "shape": "Snb" }, "MalwareName": { - "shape": "Sm3" + "shape": "Sn2" }, "MalwareType": { - "shape": "Sm3" + "shape": "Sn2" }, "MalwarePath": { - "shape": "Sm3" + "shape": "Sn2" }, "MalwareState": { - "shape": "Sm3" + "shape": "Sn2" }, "NetworkDirection": { - "shape": "Sm3" + "shape": "Sn2" }, "NetworkProtocol": { - "shape": "Sm3" + "shape": "Sn2" }, "NetworkSourceIpV4": { - "shape": "Smf" + "shape": "Sne" }, "NetworkSourceIpV6": { - "shape": "Smf" + "shape": "Sne" }, "NetworkSourcePort": { - "shape": "Sma" + "shape": "Sn9" }, "NetworkSourceDomain": { - "shape": "Sm3" + "shape": "Sn2" }, "NetworkSourceMac": { - "shape": "Sm3" + "shape": "Sn2" }, "NetworkDestinationIpV4": { - "shape": "Smf" + "shape": "Sne" }, "NetworkDestinationIpV6": { - "shape": "Smf" + "shape": "Sne" }, "NetworkDestinationPort": { - "shape": "Sma" + "shape": "Sn9" }, "NetworkDestinationDomain": { - "shape": "Sm3" + "shape": "Sn2" }, "ProcessName": { - "shape": "Sm3" + "shape": "Sn2" }, "ProcessPath": { - "shape": "Sm3" + "shape": "Sn2" }, "ProcessPid": { - "shape": "Sma" + "shape": "Sn9" }, "ProcessParentPid": { - "shape": "Sma" + "shape": "Sn9" }, "ProcessLaunchedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "ProcessTerminatedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "ThreatIntelIndicatorType": { - "shape": "Sm3" + "shape": "Sn2" }, "ThreatIntelIndicatorValue": { - "shape": "Sm3" + "shape": "Sn2" }, "ThreatIntelIndicatorCategory": { - "shape": "Sm3" + "shape": "Sn2" }, "ThreatIntelIndicatorLastObservedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "ThreatIntelIndicatorSource": { - "shape": "Sm3" + "shape": "Sn2" }, "ThreatIntelIndicatorSourceUrl": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceType": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceId": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourcePartition": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceRegion": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceTags": { - "shape": "Smc" + "shape": "Snb" }, "ResourceAwsEc2InstanceType": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsEc2InstanceImageId": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsEc2InstanceIpV4Addresses": { - "shape": "Smf" + "shape": "Sne" }, "ResourceAwsEc2InstanceIpV6Addresses": { - "shape": "Smf" + "shape": "Sne" }, "ResourceAwsEc2InstanceKeyName": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsEc2InstanceIamInstanceProfileArn": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsEc2InstanceVpcId": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsEc2InstanceSubnetId": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsEc2InstanceLaunchedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "ResourceAwsS3BucketOwnerId": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsS3BucketOwnerName": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsIamAccessKeyUserName": { - "shape": "Sm3", + "shape": "Sn2", "deprecated": true, "deprecatedMessage": "This filter is deprecated. Instead, use ResourceAwsIamAccessKeyPrincipalName." }, "ResourceAwsIamAccessKeyPrincipalName": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsIamAccessKeyStatus": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceAwsIamAccessKeyCreatedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "ResourceAwsIamUserUserName": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceContainerName": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceContainerImageId": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceContainerImageName": { - "shape": "Sm3" + "shape": "Sn2" }, "ResourceContainerLaunchedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "ResourceDetailsOther": { - "shape": "Smc" + "shape": "Snb" }, "ComplianceStatus": { - "shape": "Sm3" + "shape": "Sn2" }, "VerificationState": { - "shape": "Sm3" + "shape": "Sn2" }, "WorkflowState": { - "shape": "Sm3" + "shape": "Sn2" }, "WorkflowStatus": { - "shape": "Sm3" + "shape": "Sn2" }, "RecordState": { - "shape": "Sm3" + "shape": "Sn2" }, "RelatedFindingsProductArn": { - "shape": "Sm3" + "shape": "Sn2" }, "RelatedFindingsId": { - "shape": "Sm3" + "shape": "Sn2" }, "NoteText": { - "shape": "Sm3" + "shape": "Sn2" }, "NoteUpdatedAt": { - "shape": "Sm6" + "shape": "Sn5" }, "NoteUpdatedBy": { - "shape": "Sm3" + "shape": "Sn2" }, "Keyword": { "deprecated": true, @@ -8898,25 +9205,25 @@ } }, "FindingProviderFieldsConfidence": { - "shape": "Sma" + "shape": "Sn9" }, "FindingProviderFieldsCriticality": { - "shape": "Sma" + "shape": "Sn9" }, "FindingProviderFieldsRelatedFindingsId": { - "shape": "Sm3" + "shape": "Sn2" }, "FindingProviderFieldsRelatedFindingsProductArn": { - "shape": "Sm3" + "shape": "Sn2" }, "FindingProviderFieldsSeverityLabel": { - "shape": "Sm3" + "shape": "Sn2" }, "FindingProviderFieldsSeverityOriginal": { - "shape": "Sm3" + "shape": "Sn2" }, "FindingProviderFieldsTypes": { - "shape": "Sm3" + "shape": "Sn2" }, "Sample": { "type": "list", @@ -8930,14 +9237,14 @@ } }, "ComplianceSecurityControlId": { - "shape": "Sm3" + "shape": "Sn2" }, "ComplianceAssociatedStandardsId": { - "shape": "Sm3" + "shape": "Sn2" } } }, - "Sm3": { + "Sn2": { "type": "list", "member": { "type": "structure", @@ -8947,7 +9254,7 @@ } } }, - "Sm6": { + "Sn5": { "type": "list", "member": { "type": "structure", @@ -8966,7 +9273,7 @@ } } }, - "Sma": { + "Sn9": { "type": "list", "member": { "type": "structure", @@ -8983,7 +9290,7 @@ } } }, - "Smc": { + "Snb": { "type": "list", "member": { "type": "structure", @@ -8994,7 +9301,7 @@ } } }, - "Smf": { + "Sne": { "type": "list", "member": { "type": "structure", @@ -9003,7 +9310,7 @@ } } }, - "Smr": { + "Snq": { "type": "list", "member": { "type": "structure", @@ -9013,20 +9320,20 @@ } } }, - "Smu": { + "Snt": { "type": "list", "member": {} }, - "Sn7": { + "So6": { "type": "list", "member": {} }, - "Sog": { + "Spf": { "type": "map", "key": {}, "value": {} }, - "Som": { + "Spl": { "type": "structure", "members": { "AccountId": {}, @@ -9037,7 +9344,7 @@ "MemberStatus": {} } }, - "Spk": { + "Sqj": { "type": "list", "member": { "type": "structure", diff --git a/apis/securityhub-2018-10-26.normal.json b/apis/securityhub-2018-10-26.normal.json index 561eb03675..7cc63e2213 100644 --- a/apis/securityhub-2018-10-26.normal.json +++ b/apis/securityhub-2018-10-26.normal.json @@ -2191,6 +2191,222 @@ "shape": "AvailabilityZone" } }, + "AwsAmazonMqBrokerDetails": { + "type": "structure", + "members": { + "AuthenticationStrategy": { + "shape": "NonEmptyString", + "documentation": " The authentication strategy used to secure the broker. The default is SIMPLE
.
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
" + }, + "BrokerArn": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the broker.
" + }, + "BrokerName": { + "shape": "NonEmptyString", + "documentation": "The broker's name.
" + }, + "DeploymentMode": { + "shape": "NonEmptyString", + "documentation": "The broker's deployment mode.
" + }, + "EncryptionOptions": { + "shape": "AwsAmazonMqBrokerEncryptionOptionsDetails", + "documentation": "Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
" + }, + "EngineType": { + "shape": "NonEmptyString", + "documentation": "The type of broker engine.
" + }, + "EngineVersion": { + "shape": "NonEmptyString", + "documentation": "The version of the broker engine.
" + }, + "HostInstanceType": { + "shape": "NonEmptyString", + "documentation": "The broker's instance type.
" + }, + "BrokerId": { + "shape": "NonEmptyString", + "documentation": "The unique ID that Amazon MQ generates for the broker.
" + }, + "LdapServerMetadata": { + "shape": "AwsAmazonMqBrokerLdapServerMetadataDetails", + "documentation": "The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.
" + }, + "Logs": { + "shape": "AwsAmazonMqBrokerLogsDetails", + "documentation": "Turns on Amazon CloudWatch logging for brokers.
" + }, + "MaintenanceWindowStartTime": { + "shape": "AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails", + "documentation": "The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
" + }, + "PubliclyAccessible": { + "shape": "Boolean", + "documentation": "Permits connections from applications outside of the VPC that hosts the broker's subnets.
" + }, + "SecurityGroups": { + "shape": "StringList", + "documentation": "The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
" + }, + "StorageType": { + "shape": "NonEmptyString", + "documentation": "The broker's storage type.
" + }, + "SubnetIds": { + "shape": "StringList", + "documentation": "The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
" + }, + "Users": { + "shape": "AwsAmazonMqBrokerUsersList", + "documentation": "The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
" + } + }, + "documentation": "Provides details about an Amazon MQ message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
" + }, + "AwsAmazonMqBrokerEncryptionOptionsDetails": { + "type": "structure", + "members": { + "KmsKeyId": { + "shape": "NonEmptyString", + "documentation": "The KMS key that’s used to encrypt your data at rest. If not provided, Amazon MQ will use a default KMS key to encrypt your data.
" + }, + "UseAwsOwnedKey": { + "shape": "Boolean", + "documentation": " Specifies that an KMS key should be used for at-rest encryption. Set to true
by default if no value is provided (for example, for RabbitMQ brokers).
Provides details about broker encryption options.
" + }, + "AwsAmazonMqBrokerLdapServerMetadataDetails": { + "type": "structure", + "members": { + "Hosts": { + "shape": "StringList", + "documentation": "Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
" + }, + "RoleBase": { + "shape": "NonEmptyString", + "documentation": "The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
" + }, + "RoleName": { + "shape": "NonEmptyString", + "documentation": "The group name attribute in a role entry whose value is the name of that role.
" + }, + "RoleSearchMatching": { + "shape": "NonEmptyString", + "documentation": " The LDAP search filter used to find roles within the roleBase
.
The directory search scope for the role. If set to true
, the scope is to search the entire subtree.
A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
" + }, + "UserBase": { + "shape": "NonEmptyString", + "documentation": "Selects a particular subtree of the directory information tree (DIT) to search for user entries.
" + }, + "UserRoleName": { + "shape": "NonEmptyString", + "documentation": "The name of the LDAP attribute in the user's directory entry for the user's group membership.
" + }, + "UserSearchMatching": { + "shape": "NonEmptyString", + "documentation": " The LDAP search filter used to find users within the userBase
.
The directory search scope for the user. If set to true, the scope is to search the entire subtree.
" + } + }, + "documentation": "The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.
" + }, + "AwsAmazonMqBrokerLogsDetails": { + "type": "structure", + "members": { + "Audit": { + "shape": "Boolean", + "documentation": "Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
" + }, + "General": { + "shape": "Boolean", + "documentation": "Activates general logging.
" + }, + "AuditLogGroup": { + "shape": "NonEmptyString", + "documentation": "The location of the CloudWatch Logs log group where audit logs are sent.
" + }, + "GeneralLogGroup": { + "shape": "NonEmptyString", + "documentation": "The location of the CloudWatch Logs log group where general logs are sent.
" + }, + "Pending": { + "shape": "AwsAmazonMqBrokerLogsPendingDetails", + "documentation": "The list of information about logs that are to be turned on for the specified broker.
" + } + }, + "documentation": "Provides information about logs to be activated for the specified broker.
" + }, + "AwsAmazonMqBrokerLogsPendingDetails": { + "type": "structure", + "members": { + "Audit": { + "shape": "Boolean", + "documentation": "Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
" + }, + "General": { + "shape": "Boolean", + "documentation": "Activates general logging.
" + } + }, + "documentation": "Provides information about logs to be activated for the specified broker.
" + }, + "AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails": { + "type": "structure", + "members": { + "DayOfWeek": { + "shape": "NonEmptyString", + "documentation": "The day of the week on which the maintenance window falls.
" + }, + "TimeOfDay": { + "shape": "NonEmptyString", + "documentation": "The time, in 24-hour format, on which the maintenance window falls.
" + }, + "TimeZone": { + "shape": "NonEmptyString", + "documentation": "The time zone in either the Country/City format or the UTC offset format. UTC is the default format.
" + } + }, + "documentation": "The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
" + }, + "AwsAmazonMqBrokerUsersDetails": { + "type": "structure", + "members": { + "PendingChange": { + "shape": "NonEmptyString", + "documentation": "The type of change pending for the broker user.
" + }, + "Username": { + "shape": "NonEmptyString", + "documentation": "The username of the broker user.
" + } + }, + "documentation": "Provides details about the broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
" + }, + "AwsAmazonMqBrokerUsersList": { + "type": "list", + "member": { + "shape": "AwsAmazonMqBrokerUsersDetails" + } + }, "AwsApiCallAction": { "type": "structure", "members": { @@ -2587,6 +2803,168 @@ }, "documentation": "Contains information about a version 2 stage for Amazon API Gateway.
" }, + "AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails": { + "type": "structure", + "members": { + "AuthenticationType": { + "shape": "NonEmptyString", + "documentation": "The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
" + }, + "LambdaAuthorizerConfig": { + "shape": "AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails", + "documentation": "The configuration for Lambda function authorization.
" + }, + "OpenIdConnectConfig": { + "shape": "AwsAppSyncGraphQlApiOpenIdConnectConfigDetails", + "documentation": "The OpenID Connect configuration.
" + }, + "UserPoolConfig": { + "shape": "AwsAppSyncGraphQlApiUserPoolConfigDetails", + "documentation": "The Amazon Cognito user pools configuration.
" + } + }, + "documentation": "A list of additional authentication providers for the GraphqlApi API.
" + }, + "AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList": { + "type": "list", + "member": { + "shape": "AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails" + } + }, + "AwsAppSyncGraphQlApiDetails": { + "type": "structure", + "members": { + "ApiId": { + "shape": "NonEmptyString", + "documentation": "The unique identifier for the API.
" + }, + "Id": { + "shape": "NonEmptyString", + "documentation": "The unique identifier for the API.
" + }, + "OpenIdConnectConfig": { + "shape": "AwsAppSyncGraphQlApiOpenIdConnectConfigDetails", + "documentation": "Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
" + }, + "Name": { + "shape": "NonEmptyString", + "documentation": "The API name.
" + }, + "LambdaAuthorizerConfig": { + "shape": "AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails", + "documentation": "Specifies the configuration for Lambda function authorization.
" + }, + "XrayEnabled": { + "shape": "Boolean", + "documentation": "Indicates whether to use X-Ray tracing for the GraphQL API.
" + }, + "Arn": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the API.
" + }, + "UserPoolConfig": { + "shape": "AwsAppSyncGraphQlApiUserPoolConfigDetails", + "documentation": "The Amazon Cognito user pools configuration.
" + }, + "AuthenticationType": { + "shape": "NonEmptyString", + "documentation": "The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
" + }, + "LogConfig": { + "shape": "AwsAppSyncGraphQlApiLogConfigDetails", + "documentation": "The Amazon CloudWatch Logs configuration.
" + }, + "AdditionalAuthenticationProviders": { + "shape": "AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList", + "documentation": "A list of additional authentication providers for the GraphQL API.
" + }, + "WafWebAclArn": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
" + } + }, + "documentation": "Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.
" + }, + "AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails": { + "type": "structure", + "members": { + "AuthorizerResultTtlInSeconds": { + "shape": "Integer", + "documentation": "The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).
" + }, + "AuthorizerUri": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
" + }, + "IdentityValidationExpression": { + "shape": "NonEmptyString", + "documentation": "A regular expression for validation of tokens before the Lambda function is called.
" + } + }, + "documentation": "Specifies the authorization configuration for using an Lambda function with your AppSync GraphQL API endpoint.
" + }, + "AwsAppSyncGraphQlApiLogConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogsRoleArn": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the service role that AppSync assumes to publish to CloudWatch Logs in your account.
" + }, + "ExcludeVerboseContent": { + "shape": "Boolean", + "documentation": " Set to TRUE
to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
The field logging level.
" + } + }, + "documentation": "Specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AppSync GraphQL API.
" + }, + "AwsAppSyncGraphQlApiOpenIdConnectConfigDetails": { + "type": "structure", + "members": { + "AuthTtL": { + "shape": "Long", + "documentation": "The number of milliseconds that a token is valid after being authenticated.
" + }, + "ClientId": { + "shape": "NonEmptyString", + "documentation": "The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
" + }, + "IatTtL": { + "shape": "Long", + "documentation": "The number of milliseconds that a token is valid after it's issued to a user.
" + }, + "Issuer": { + "shape": "NonEmptyString", + "documentation": " The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss
in the ID token.
Specifies the authorization configuration for using an OpenID Connect compliant service with your AppSync GraphQL API endpoint.
" + }, + "AwsAppSyncGraphQlApiUserPoolConfigDetails": { + "type": "structure", + "members": { + "AppIdClientRegex": { + "shape": "NonEmptyString", + "documentation": "A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no filtering is applied.
" + }, + "AwsRegion": { + "shape": "NonEmptyString", + "documentation": "The Amazon Web Services Region in which the user pool was created.
" + }, + "DefaultAction": { + "shape": "NonEmptyString", + "documentation": "The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools authentication doesn't match the Amazon Cognito user pools configuration.
" + }, + "UserPoolId": { + "shape": "NonEmptyString", + "documentation": "The user pool ID.
" + } + }, + "documentation": "Specifies the authorization configuration for using Amazon Cognito user pools with your AppSync GraphQL API endpoint.
" + }, "AwsAutoScalingAutoScalingGroupAvailabilityZonesList": { "type": "list", "member": { @@ -9062,6 +9440,198 @@ }, "documentation": "Information about a load balancer.
" }, + "AwsEventSchemasRegistryDetails": { + "type": "structure", + "members": { + "Description": { + "shape": "NonEmptyString", + "documentation": "A description of the registry to be created.
" + }, + "RegistryArn": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the registry.
" + }, + "RegistryName": { + "shape": "NonEmptyString", + "documentation": "The name of the schema registry.
" + } + }, + "documentation": "A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.
" + }, + "AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { + "type": "structure", + "members": { + "Status": { + "shape": "NonEmptyString", + "documentation": "Specifies whether CloudTrail is activated as a data source for the detector.
" + } + }, + "documentation": "An object that contains information on the status of CloudTrail as a data source for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesDetails": { + "type": "structure", + "members": { + "CloudTrail": { + "shape": "AwsGuardDutyDetectorDataSourcesCloudTrailDetails", + "documentation": "An object that contains information on the status of CloudTrail as a data source for the detector.
" + }, + "DnsLogs": { + "shape": "AwsGuardDutyDetectorDataSourcesDnsLogsDetails", + "documentation": "An object that contains information on the status of DNS logs as a data source for the detector.
" + }, + "FlowLogs": { + "shape": "AwsGuardDutyDetectorDataSourcesFlowLogsDetails", + "documentation": "An object that contains information on the status of VPC Flow Logs as a data source for the detector.
" + }, + "Kubernetes": { + "shape": "AwsGuardDutyDetectorDataSourcesKubernetesDetails", + "documentation": "An object that contains information on the status of Kubernetes data sources for the detector.
" + }, + "MalwareProtection": { + "shape": "AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", + "documentation": "An object that contains information on the status of Malware Protection as a data source for the detector.
" + }, + "S3Logs": { + "shape": "AwsGuardDutyDetectorDataSourcesS3LogsDetails", + "documentation": "An object that contains information on the status of S3 Data event logs as a data source for the detector.
" + } + }, + "documentation": "Describes which data sources are activated for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesDnsLogsDetails": { + "type": "structure", + "members": { + "Status": { + "shape": "NonEmptyString", + "documentation": "Describes whether DNS logs is enabled as a data source for the detector.
" + } + }, + "documentation": "An object that contains information on the status of DNS logs as a data source for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesFlowLogsDetails": { + "type": "structure", + "members": { + "Status": { + "shape": "NonEmptyString", + "documentation": "Describes whether VPC Flow Logs are activated as a data source for the detector.
" + } + }, + "documentation": "An object that contains information on the status of VPC Flow Logs as a data source for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails": { + "type": "structure", + "members": { + "Status": { + "shape": "NonEmptyString", + "documentation": "Describes whether Kubernetes audit logs are activated as a data source for the detector.
" + } + }, + "documentation": "An object that contains information on the status of Kubernetes audit logs as a data source for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesKubernetesDetails": { + "type": "structure", + "members": { + "AuditLogs": { + "shape": "AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails", + "documentation": "Describes whether Kubernetes audit logs are activated as a data source for the detector.
" + } + }, + "documentation": "An object that contains information on the status of Kubernetes data sources for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "shape": "AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails", + "documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
" + }, + "ServiceRole": { + "shape": "NonEmptyString", + "documentation": "The GuardDuty Malware Protection service role.
" + } + }, + "documentation": "An object that contains information on the status of Malware Protection as a data source for the detector.
" + }, + "AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails": { + "type": "structure", + "members": { + "EbsVolumes": { + "shape": "AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails", + "documentation": "Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.
" + } + }, + "documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
" + }, + "AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails": { + "type": "structure", + "members": { + "Reason": { + "shape": "NonEmptyString", + "documentation": "Specifies the reason why scanning EBS volumes (Malware Protection) isn’t activated as a data source.
" + }, + "Status": { + "shape": "NonEmptyString", + "documentation": "Describes whether scanning EBS volumes is activated as a data source for the detector.
" + } + }, + "documentation": "Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.
" + }, + "AwsGuardDutyDetectorDataSourcesS3LogsDetails": { + "type": "structure", + "members": { + "Status": { + "shape": "NonEmptyString", + "documentation": "A value that describes whether S3 data event logs are automatically enabled for new members of an organization.
" + } + }, + "documentation": "An object that contains information on the status of S3 data event logs as a data source for the detector.
" + }, + "AwsGuardDutyDetectorDetails": { + "type": "structure", + "members": { + "DataSources": { + "shape": "AwsGuardDutyDetectorDataSourcesDetails", + "documentation": "Describes which data sources are activated for the detector.
" + }, + "Features": { + "shape": "AwsGuardDutyDetectorFeaturesList", + "documentation": "Describes which features are activated for the detector.
" + }, + "FindingPublishingFrequency": { + "shape": "NonEmptyString", + "documentation": "The publishing frequency of the finding.
" + }, + "ServiceRole": { + "shape": "NonEmptyString", + "documentation": "The GuardDuty service role.
" + }, + "Status": { + "shape": "NonEmptyString", + "documentation": "The activation status of the detector.
" + } + }, + "documentation": "Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.
" + }, + "AwsGuardDutyDetectorFeaturesDetails": { + "type": "structure", + "members": { + "Name": { + "shape": "NonEmptyString", + "documentation": "Indicates the name of the feature that is activated for the detector.
" + }, + "Status": { + "shape": "NonEmptyString", + "documentation": "Indicates the status of the feature that is activated for the detector.
" + } + }, + "documentation": "Describes which features are activated for the detector.
" + }, + "AwsGuardDutyDetectorFeaturesList": { + "type": "list", + "member": { + "shape": "AwsGuardDutyDetectorFeaturesDetails" + } + }, "AwsIamAccessKeyDetails": { "type": "structure", "members": { @@ -13427,6 +13997,98 @@ }, "documentation": "Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.
" }, + "AwsStepFunctionStateMachineDetails": { + "type": "structure", + "members": { + "Label": { + "shape": "NonEmptyString", + "documentation": " A user-defined or an auto-generated string that identifies a Map
state. This parameter is present only if the stateMachineArn
specified in input is a qualified state machine ARN.
Used to set CloudWatch Logs options.
" + }, + "Name": { + "shape": "NonEmptyString", + "documentation": "The name of the state machine.
" + }, + "RoleArn": { + "shape": "NonEmptyString", + "documentation": "The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
" + }, + "StateMachineArn": { + "shape": "NonEmptyString", + "documentation": "The ARN that identifies the state machine.
" + }, + "Status": { + "shape": "NonEmptyString", + "documentation": "The current status of the state machine.
" + }, + "TracingConfiguration": { + "shape": "AwsStepFunctionStateMachineTracingConfigurationDetails", + "documentation": "Specifies whether X-Ray tracing is enabled.
" + }, + "Type": { + "shape": "NonEmptyString", + "documentation": "The type of the state machine (STANDARD or EXPRESS).
" + } + }, + "documentation": "Provides details about an Step Functions state machine, which is a workflow consisting of a series of event- driven steps.
" + }, + "AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails": { + "type": "structure", + "members": { + "LogGroupArn": { + "shape": "NonEmptyString", + "documentation": "The ARN (ends with :*
) of the CloudWatch Logs log group to which you want your logs emitted.
An object describing a CloudWatch log group. For more information, see Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.
" + }, + "AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroup": { + "shape": "AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails", + "documentation": "An object describing a CloudWatch Logs log group. For more information, see Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.
" + } + }, + "documentation": "An array of objects that describes where your execution history events will be logged.
" + }, + "AwsStepFunctionStateMachineLoggingConfigurationDestinationsList": { + "type": "list", + "member": { + "shape": "AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails" + } + }, + "AwsStepFunctionStateMachineLoggingConfigurationDetails": { + "type": "structure", + "members": { + "Destinations": { + "shape": "AwsStepFunctionStateMachineLoggingConfigurationDestinationsList", + "documentation": "An array of objects that describes where your execution history events will be logged.
" + }, + "IncludeExecutionData": { + "shape": "Boolean", + "documentation": "Determines whether execution data is included in your log. When set to false, data is excluded.
" + }, + "Level": { + "shape": "NonEmptyString", + "documentation": "Defines which category of execution history events are logged.
" + } + }, + "documentation": " The LoggingConfiguration
data type is used to set CloudWatch Logs options.
When set to true, X-Ray tracing is enabled.
" + } + }, + "documentation": "Specifies whether X-Ray tracing is enabled.
" + }, "AwsWafRateBasedRuleDetails": { "type": "structure", "members": { @@ -15464,7 +16126,7 @@ }, "UpdateTime": { "shape": "Timestamp", - "documentation": " An ISO 8601-formatted timestamp that indicates when the security findings provider last updated the finding record. A correctly formatted example is 2020-05-21T20:16:34.724Z
. The value cannot contain spaces, and date and time should be separated by T
. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO 8601-formatted timestamp that indicates when Security Hub processed the updated finding record.
A correctly formatted example is 2020-05-21T20:16:34.724Z
. The value cannot contain spaces, and date and time should be separated by T
. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.
" + }, + "AwsAmazonMqBroker": { + "shape": "AwsAmazonMqBrokerDetails", + "documentation": "Provides details about AppSync message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
" + }, + "AwsAppSyncGraphQlApi": { + "shape": "AwsAppSyncGraphQlApiDetails", + "documentation": "Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.
" + }, + "AwsEventSchemasRegistry": { + "shape": "AwsEventSchemasRegistryDetails", + "documentation": "A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.
" + }, + "AwsGuardDutyDetector": { + "shape": "AwsGuardDutyDetectorDetails", + "documentation": "Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.
" + }, + "AwsStepFunctionStateMachine": { + "shape": "AwsStepFunctionStateMachineDetails", + "documentation": "Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.
" } }, "documentation": "Additional details about a resource related to a finding.
To provide the details, use the object that corresponds to the resource type. For example, if the resource type is AwsEc2Instance
, then you use the AwsEc2Instance
object to provide the details.
If the type-specific object does not contain all of the fields you want to populate, then you use the Other
object to populate those additional fields.
You also use the Other
object to populate the details when the selected type does not have a corresponding object.
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.
You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource
to enable data collection from a custom source.
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it,
You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource
to enable data collection from a custom source.
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source in addition to an associated Glue table and an Glue crawler.
" + "documentation": "Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.
", + "idempotent": true }, - "CreateDatalake": { - "name": "CreateDatalake", + "CreateDataLake": { + "name": "CreateDataLake", "http": { "method": "POST", "requestUri": "/v1/datalake", "responseCode": 200 }, "input": { - "shape": "CreateDatalakeRequest" + "shape": "CreateDataLakeRequest" }, "output": { - "shape": "CreateDatalakeResponse" + "shape": "CreateDataLakeResponse" }, "errors": [ { - "shape": "ServiceQuotaExceededException" + "shape": "BadRequestException" }, { - "shape": "ConflictException" + "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { - "shape": "ValidationException" - }, - { - "shape": "ThrottlingException" + "shape": "AccessDeniedException" }, { - "shape": "AccessDeniedException" + "shape": "ConflictException" }, { - "shape": "ResourceNotFoundException" + "shape": "ThrottlingException" } ], - "documentation": "Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. You can either use the enableAll
parameter to specify all Regions or specify the Regions where you want to enable Security Lake. To specify particular Regions, use the Regions
parameter and then configure these Regions using the configurations
parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.
When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource
call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.
Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. By default, the CreateDataLake
Security Lake in all Regions. To specify particular Regions, configure these Regions using the configurations
parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.
When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource
call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.
Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.
" - }, - "CreateDatalakeDelegatedAdmin": { - "name": "CreateDatalakeDelegatedAdmin", - "http": { - "method": "POST", - "requestUri": "/v1/datalake/delegate", - "responseCode": 200 - }, - "input": { - "shape": "CreateDatalakeDelegatedAdminRequest" - }, - "output": { - "shape": "CreateDatalakeDelegatedAdminResponse" - }, - "errors": [ { "shape": "InternalServerException" }, { - "shape": "ValidationException" + "shape": "AccessDeniedException" }, { - "shape": "ThrottlingException" + "shape": "ConflictException" }, { - "shape": "AccessDeniedException" + "shape": "ThrottlingException" } ], - "documentation": "Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
" + "documentation": "Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
" }, - "CreateDatalakeExceptionsSubscription": { - "name": "CreateDatalakeExceptionsSubscription", + "CreateDataLakeOrganizationConfiguration": { + "name": "CreateDataLakeOrganizationConfiguration", "http": { "method": "POST", - "requestUri": "/v1/datalake/exceptions/subscription", + "requestUri": "/v1/datalake/organization/configuration", "responseCode": 200 }, "input": { - "shape": "CreateDatalakeExceptionsSubscriptionRequest" + "shape": "CreateDataLakeOrganizationConfigurationRequest" }, "output": { - "shape": "CreateDatalakeExceptionsSubscriptionResponse" + "shape": "CreateDataLakeOrganizationConfigurationResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
" + "documentation": "Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.
" }, "CreateSubscriber": { "name": "CreateSubscriber", @@ -225,66 +203,57 @@ }, "errors": [ { - "shape": "ConflictSubscriptionException" + "shape": "BadRequestException" }, { - "shape": "InternalServerException" + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "BucketNotFoundException" - }, - { - "shape": "ResourceNotFoundException" - }, - { - "shape": "AccountNotFoundException" + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], "documentation": "Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
" }, - "CreateSubscriptionNotificationConfiguration": { - "name": "CreateSubscriptionNotificationConfiguration", + "CreateSubscriberNotification": { + "name": "CreateSubscriberNotification", "http": { "method": "POST", - "requestUri": "/subscription-notifications/{subscriptionId}", + "requestUri": "/v1/subscribers/{subscriberId}/notification", "responseCode": 200 }, "input": { - "shape": "CreateSubscriptionNotificationConfigurationRequest" + "shape": "CreateSubscriberNotificationRequest" }, "output": { - "shape": "CreateSubscriptionNotificationConfigurationResponse" + "shape": "CreateSubscriberNotificationResponse" }, "errors": [ { - "shape": "ConcurrentModificationException" + "shape": "BadRequestException" }, { - "shape": "InternalServerException" + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" - }, - { - "shape": "AccountNotFoundException" + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], "documentation": "Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.
" @@ -293,7 +262,7 @@ "name": "DeleteAwsLogSource", "http": { "method": "POST", - "requestUri": "/v1/logsources/aws/delete", + "requestUri": "/v1/datalake/logsources/aws/delete", "responseCode": 200 }, "input": { @@ -304,25 +273,31 @@ }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" }, { - "shape": "ValidationException" + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.
You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.
When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.
" + "documentation": "Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal.
You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.
" }, "DeleteCustomLogSource": { "name": "DeleteCustomLogSource", "http": { "method": "DELETE", - "requestUri": "/v1/logsources/custom", + "requestUri": "/v1/datalake/logsources/custom/{sourceName}", "responseCode": 200 }, "input": { @@ -333,161 +308,139 @@ }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" }, { - "shape": "ValidationException" + "shape": "ResourceNotFoundException" }, { - "shape": "ConflictSourceNamesException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "BucketNotFoundException" - }, - { - "shape": "ResourceNotFoundException" + "shape": "ConflictException" }, { - "shape": "AccountNotFoundException" + "shape": "ThrottlingException" } ], - "documentation": "Removes a custom log source from Amazon Security Lake.
", + "documentation": "Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
", "idempotent": true }, - "DeleteDatalake": { - "name": "DeleteDatalake", + "DeleteDataLake": { + "name": "DeleteDataLake", "http": { - "method": "DELETE", - "requestUri": "/v1/datalake", + "method": "POST", + "requestUri": "/v1/datalake/delete", "responseCode": 200 }, "input": { - "shape": "DeleteDatalakeRequest" + "shape": "DeleteDataLakeRequest" }, "output": { - "shape": "DeleteDatalakeResponse" + "shape": "DeleteDataLakeResponse" }, "errors": [ { - "shape": "ServiceQuotaExceededException" + "shape": "BadRequestException" }, { - "shape": "ConflictException" + "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { - "shape": "ValidationException" - }, - { - "shape": "ThrottlingException" + "shape": "AccessDeniedException" }, { - "shape": "AccessDeniedException" + "shape": "ConflictException" }, { - "shape": "ResourceNotFoundException" + "shape": "ThrottlingException" } ], - "documentation": "When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from Security Lake .
This operation disables security data collection from sources, deletes data stored, and stops making data accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. The DeleteDatalake
operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region.
The DeleteDataLake
operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
DeleteDatalakeAutoEnable
removes automatic enablement of configuration settings for new member accounts (but keeps settings for the delegated administrator) from Amazon Security Lake. You must run this API using credentials of the delegated administrator. When you run this API, new member accounts that are added after the organization enables Security Lake won't contribute to the data lake.
Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
" + "documentation": "Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent": true }, - "DeleteDatalakeExceptionsSubscription": { - "name": "DeleteDatalakeExceptionsSubscription", + "DeleteDataLakeOrganizationConfiguration": { + "name": "DeleteDataLakeOrganizationConfiguration", "http": { - "method": "DELETE", - "requestUri": "/v1/datalake/exceptions/subscription", + "method": "POST", + "requestUri": "/v1/datalake/organization/configuration/delete", "responseCode": 200 }, "input": { - "shape": "DeleteDatalakeExceptionsSubscriptionRequest" + "shape": "DeleteDataLakeOrganizationConfigurationRequest" }, "output": { - "shape": "DeleteDatalakeExceptionsSubscriptionResponse" + "shape": "DeleteDataLakeOrganizationConfigurationResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
" + "documentation": "Removes automatic the enablement of configuration settings for new member accounts (but retains the settings for the delegated administrator) from Amazon Security Lake. You must run this API using the credentials of the delegated administrator. When you run this API, new member accounts that are added after the organization enables Security Lake won't contribute to the data lake.
" }, "DeleteSubscriber": { "name": "DeleteSubscriber", "http": { "method": "DELETE", - "requestUri": "/v1/subscribers", + "requestUri": "/v1/subscribers/{subscriberId}", "responseCode": 200 }, "input": { @@ -498,225 +451,209 @@ }, "errors": [ { - "shape": "ConcurrentModificationException" + "shape": "BadRequestException" }, { - "shape": "InternalServerException" + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "BucketNotFoundException" - }, - { - "shape": "ResourceNotFoundException" - }, - { - "shape": "AccountNotFoundException" + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], - "documentation": "Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services Region.
", + "documentation": "Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber
, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
", "idempotent": true }, - "GetDatalake": { - "name": "GetDatalake", + "DeregisterDataLakeDelegatedAdministrator": { + "name": "DeregisterDataLakeDelegatedAdministrator", "http": { - "method": "GET", - "requestUri": "/v1/datalake", + "method": "DELETE", + "requestUri": "/v1/datalake/delegate", "responseCode": 200 }, "input": { - "shape": "GetDatalakeRequest" + "shape": "DeregisterDataLakeDelegatedAdministratorRequest" }, "output": { - "shape": "GetDatalakeResponse" + "shape": "DeregisterDataLakeDelegatedAdministratorResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" + "shape": "ConflictException" }, { - "shape": "AccountNotFoundException" + "shape": "ThrottlingException" } ], - "documentation": "Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the GetDatalake
API to know whether Security Lake is enabled for the current Region. This API does not take input parameters.
Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
", + "idempotent": true }, - "GetDatalakeAutoEnable": { - "name": "GetDatalakeAutoEnable", + "GetDataLakeExceptionSubscription": { + "name": "GetDataLakeExceptionSubscription", "http": { "method": "GET", - "requestUri": "/v1/datalake/autoenable", + "requestUri": "/v1/datalake/exceptions/subscription", "responseCode": 200 }, "input": { - "shape": "GetDatalakeAutoEnableRequest" + "shape": "GetDataLakeExceptionSubscriptionRequest" }, "output": { - "shape": "GetDatalakeAutoEnableResponse" + "shape": "GetDataLakeExceptionSubscriptionResponse" }, "errors": [ { - "shape": "InternalServerException" - }, - { - "shape": "ValidationException" + "shape": "BadRequestException" }, { - "shape": "AccessDeniedException" + "shape": "ResourceNotFoundException" }, - { - "shape": "AccountNotFoundException" - } - ], - "documentation": "Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
" - }, - "GetDatalakeExceptionsExpiry": { - "name": "GetDatalakeExceptionsExpiry", - "http": { - "method": "GET", - "requestUri": "/v1/datalake/exceptions/expiry", - "responseCode": 200 - }, - "input": { - "shape": "GetDatalakeExceptionsExpiryRequest" - }, - "output": { - "shape": "GetDatalakeExceptionsExpiryResponse" - }, - "errors": [ { "shape": "InternalServerException" }, { - "shape": "ValidationException" + "shape": "AccessDeniedException" }, { - "shape": "AccessDeniedException" + "shape": "ConflictException" }, { - "shape": "AccountNotFoundException" + "shape": "ThrottlingException" } ], - "documentation": "Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain. Exceptions are stored by default, for 2 weeks from when a record was created in Amazon Security Lake. This API does not take input parameters.
" + "documentation": "Retrieves the details of exception notifications for the account in Amazon Security Lake.
" }, - "GetDatalakeExceptionsSubscription": { - "name": "GetDatalakeExceptionsSubscription", + "GetDataLakeOrganizationConfiguration": { + "name": "GetDataLakeOrganizationConfiguration", "http": { "method": "GET", - "requestUri": "/v1/datalake/exceptions/subscription", + "requestUri": "/v1/datalake/organization/configuration", "responseCode": 200 }, "input": { - "shape": "GetDatalakeExceptionsSubscriptionRequest" + "shape": "GetDataLakeOrganizationConfigurationRequest" }, "output": { - "shape": "GetDatalakeExceptionsSubscriptionResponse" + "shape": "GetDataLakeOrganizationConfigurationResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" }, { - "shape": "ValidationException" + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Retrieves the details of exception notifications for the account in Amazon Security Lake.
" + "documentation": "Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
" }, - "GetDatalakeStatus": { - "name": "GetDatalakeStatus", + "GetDataLakeSources": { + "name": "GetDataLakeSources", "http": { "method": "POST", - "requestUri": "/v1/datalake/status", + "requestUri": "/v1/datalake/sources", "responseCode": 200 }, "input": { - "shape": "GetDatalakeStatusRequest" + "shape": "GetDataLakeSourcesRequest" }, "output": { - "shape": "GetDatalakeStatusResponse" + "shape": "GetDataLakeSourcesResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.
" + "documentation": "Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.
" }, "GetSubscriber": { "name": "GetSubscriber", "http": { "method": "GET", - "requestUri": "/v1/subscribers/{id}", + "requestUri": "/v1/subscribers/{subscriberId}", "responseCode": 200 }, "input": { @@ -727,83 +664,130 @@ }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" }, { - "shape": "AccessDeniedException" + "shape": "ResourceNotFoundException" }, { - "shape": "ResourceNotFoundException" + "shape": "InternalServerException" }, { - "shape": "AccountNotFoundException" + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], "documentation": "Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
" }, - "ListDatalakeExceptions": { - "name": "ListDatalakeExceptions", + "ListDataLakeExceptions": { + "name": "ListDataLakeExceptions", "http": { "method": "POST", "requestUri": "/v1/datalake/exceptions", "responseCode": 200 }, "input": { - "shape": "ListDatalakeExceptionsRequest" + "shape": "ListDataLakeExceptionsRequest" }, "output": { - "shape": "ListDatalakeExceptionsResponse" + "shape": "ListDataLakeExceptionsResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], "documentation": "Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
" }, - "ListLogSources": { - "name": "ListLogSources", + "ListDataLakes": { + "name": "ListDataLakes", "http": { - "method": "POST", - "requestUri": "/v1/logsources/list", + "method": "GET", + "requestUri": "/v1/datalakes", "responseCode": 200 }, "input": { - "shape": "ListLogSourcesRequest" + "shape": "ListDataLakesRequest" }, "output": { - "shape": "ListLogSourcesResponse" + "shape": "ListDataLakesResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the ListDataLakes
API to know whether Security Lake is enabled for any region.
Retrieves the log sources in the current Amazon Web Services Region.
" + "documentation": "Retrieves the log sources in the current Amazon Web Services Region.
" }, "ListSubscribers": { "name": "ListSubscribers", @@ -820,122 +804,138 @@ }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" }, { - "shape": "ValidationException" + "shape": "ResourceNotFoundException" }, { - "shape": "AccessDeniedException" + "shape": "InternalServerException" }, { - "shape": "ResourceNotFoundException" + "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], "documentation": "List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
" }, - "UpdateDatalake": { - "name": "UpdateDatalake", + "RegisterDataLakeDelegatedAdministrator": { + "name": "RegisterDataLakeDelegatedAdministrator", "http": { - "method": "PUT", - "requestUri": "/v1/datalake", + "method": "POST", + "requestUri": "/v1/datalake/delegate", "responseCode": 200 }, "input": { - "shape": "UpdateDatalakeRequest" + "shape": "RegisterDataLakeDelegatedAdministratorRequest" }, "output": { - "shape": "UpdateDatalakeResponse" + "shape": "RegisterDataLakeDelegatedAdministratorResponse" }, "errors": [ { - "shape": "EventBridgeException" + "shape": "BadRequestException" }, { - "shape": "InternalServerException" + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
", - "idempotent": true + "documentation": "Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
" }, - "UpdateDatalakeExceptionsExpiry": { - "name": "UpdateDatalakeExceptionsExpiry", + "UpdateDataLake": { + "name": "UpdateDataLake", "http": { "method": "PUT", - "requestUri": "/v1/datalake/exceptions/expiry", + "requestUri": "/v1/datalake", "responseCode": 200 }, "input": { - "shape": "UpdateDatalakeExceptionsExpiryRequest" + "shape": "UpdateDataLakeRequest" }, "output": { - "shape": "UpdateDatalakeExceptionsExpiryResponse" + "shape": "UpdateDataLakeResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" + }, + { + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL) for the exception message to remain. Exceptions are stored by default for 2 weeks from when a record was created in Amazon Security Lake.
" + "documentation": "Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
", + "idempotent": true }, - "UpdateDatalakeExceptionsSubscription": { - "name": "UpdateDatalakeExceptionsSubscription", + "UpdateDataLakeExceptionSubscription": { + "name": "UpdateDataLakeExceptionSubscription", "http": { "method": "PUT", "requestUri": "/v1/datalake/exceptions/subscription", "responseCode": 200 }, "input": { - "shape": "UpdateDatalakeExceptionsSubscriptionRequest" + "shape": "UpdateDataLakeExceptionSubscriptionRequest" }, "output": { - "shape": "UpdateDatalakeExceptionsSubscriptionResponse" + "shape": "UpdateDataLakeExceptionSubscriptionResponse" }, "errors": [ { - "shape": "InternalServerException" + "shape": "BadRequestException" }, { - "shape": "ValidationException" + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" } ], - "documentation": "Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
" + "documentation": "Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent": true }, "UpdateSubscriber": { "name": "UpdateSubscriber", "http": { "method": "PUT", - "requestUri": "/v1/subscribers/{id}", + "requestUri": "/v1/subscribers/{subscriberId}", "responseCode": 200 }, "input": { @@ -946,67 +946,62 @@ }, "errors": [ { - "shape": "ConflictSubscriptionException" + "shape": "BadRequestException" }, { - "shape": "ConcurrentModificationException" + "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, - { - "shape": "ValidationException" - }, { "shape": "AccessDeniedException" }, { - "shape": "AccountNotFoundException" + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], - "documentation": "Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
", + "documentation": "Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
", "idempotent": true }, - "UpdateSubscriptionNotificationConfiguration": { - "name": "UpdateSubscriptionNotificationConfiguration", + "UpdateSubscriberNotification": { + "name": "UpdateSubscriberNotification", "http": { "method": "PUT", - "requestUri": "/subscription-notifications/{subscriptionId}", + "requestUri": "/v1/subscribers/{subscriberId}/notification", "responseCode": 200 }, "input": { - "shape": "UpdateSubscriptionNotificationConfigurationRequest" + "shape": "UpdateSubscriberNotificationRequest" }, "output": { - "shape": "UpdateSubscriptionNotificationConfigurationResponse" + "shape": "UpdateSubscriberNotificationResponse" }, "errors": [ { - "shape": "ConcurrentModificationException" + "shape": "BadRequestException" }, { - "shape": "InternalServerException" + "shape": "ResourceNotFoundException" }, { - "shape": "ValidationException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" - }, - { - "shape": "AccountNotFoundException" + "shape": "ConflictException" }, { - "shape": "InvalidInputException" + "shape": "ThrottlingException" } ], - "documentation": "Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
" + "documentation": "Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
", + "idempotent": true } }, "shapes": { @@ -1026,120 +1021,121 @@ "AccountList": { "type": "list", "member": { - "shape": "String" + "shape": "AwsAccountId" } }, - "AccountSources": { + "AmazonResourceName": { + "type": "string", + "max": 1011, + "min": 1, + "pattern": "^arn:aws:securitylake:[A-za-z0-9_/.\\-]{0,63}:[A-za-z0-9_/.\\-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.\\-]{0,127}$" + }, + "AwsAccountId": { + "type": "string", + "max": 12, + "min": 12, + "pattern": "^[0-9]{12}$" + }, + "AwsIdentity": { "type": "structure", "required": [ - "account", - "sourceType" + "externalId", + "principal" ], "members": { - "account": { - "shape": "String", - "documentation": "The ID of the Security Lake account for which logs are collected.
" - }, - "eventClass": { - "shape": "OcsfEventClass", - "documentation": "Initializes a new instance of the Event class.
" - }, - "logsStatus": { - "shape": "LogsStatusList", - "documentation": "The log status for the Security Lake account.
" + "externalId": { + "shape": "ExternalId", + "documentation": "The external ID used to estalish trust relationship with the AWS identity.
" }, - "sourceType": { - "shape": "String", - "documentation": "The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" + "principal": { + "shape": "AwsPrincipal", + "documentation": "The AWS identity principal.
" } }, - "documentation": "Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" - }, - "AccountSourcesList": { - "type": "list", - "member": { - "shape": "AccountSources" - } - }, - "AllDimensionsMap": { - "type": "map", - "key": { - "shape": "String" - }, - "value": { - "shape": "TwoDimensionsMap" - } + "documentation": "The AWS identity.
" }, - "AutoEnableNewRegionConfiguration": { + "AwsLogSourceConfiguration": { "type": "structure", "required": [ - "region", - "sources" + "regions", + "sourceName" ], "members": { - "region": { - "shape": "Region", - "documentation": "The Amazon Web Services Regions where Security Lake is automatically enabled.
" + "accounts": { + "shape": "AccountList", + "documentation": "Specify the Amazon Web Services account information where you want to enable Security Lake.
" }, - "sources": { - "shape": "AwsSourceTypeList", - "documentation": "The Amazon Web Services sources that are automatically enabled in Security Lake.
" + "regions": { + "shape": "RegionList", + "documentation": "Specify the Regions where you want to enable Security Lake.
" + }, + "sourceName": { + "shape": "AwsLogSourceName", + "documentation": "The name for a Amazon Web Services source. This must be a Regionally unique value.
" + }, + "sourceVersion": { + "shape": "AwsLogSourceVersion", + "documentation": "The version for a Amazon Web Services source. This must be a Regionally unique value.
" } }, - "documentation": "Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
" + "documentation": "The Security Lake logs source configuration file describes the information needed to generate Security Lake logs.
" }, - "AutoEnableNewRegionConfigurationList": { + "AwsLogSourceConfigurationList": { "type": "list", "member": { - "shape": "AutoEnableNewRegionConfiguration" - } - }, - "AwsAccountId": { - "type": "string", - "max": 12, - "min": 12, - "pattern": "^\\d+$" + "shape": "AwsLogSourceConfiguration" + }, + "max": 50, + "min": 0 }, - "AwsLogSourceType": { + "AwsLogSourceName": { "type": "string", "enum": [ "ROUTE53", "VPC_FLOW", - "CLOUD_TRAIL", - "SH_FINDINGS" + "SH_FINDINGS", + "CLOUD_TRAIL_MGMT", + "LAMBDA_EXECUTION", + "S3_DATA" ] }, - "AwsSourceTypeList": { + "AwsLogSourceResource": { + "type": "structure", + "members": { + "sourceName": { + "shape": "AwsLogSourceName", + "documentation": "The name for a Amazon Web Services source. This must be a Regionally unique value.
" + }, + "sourceVersion": { + "shape": "AwsLogSourceVersion", + "documentation": "The version for a Amazon Web Services source. This must be a Regionally unique value.
" + } + }, + "documentation": "Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.
" + }, + "AwsLogSourceResourceList": { "type": "list", "member": { - "shape": "AwsLogSourceType" + "shape": "AwsLogSourceResource" } }, - "Boolean": { - "type": "boolean", - "box": true + "AwsLogSourceVersion": { + "type": "string", + "pattern": "^(latest|[0-9]\\.[0-9])$" + }, + "AwsPrincipal": { + "type": "string", + "pattern": "^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$" }, "CreateAwsLogSourceRequest": { "type": "structure", "required": [ - "inputOrder" + "sources" ], "members": { - "enableAllDimensions": { - "shape": "AllDimensionsMap", - "documentation": "Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.
" - }, - "enableSingleDimension": { - "shape": "InputSet", - "documentation": "Enables data collection from all Amazon Web Services sources in specific accounts or Regions.
" - }, - "enableTwoDimensions": { - "shape": "TwoDimensionsMap", - "documentation": "Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.
" - }, - "inputOrder": { - "shape": "DimensionSet", - "documentation": "Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member account.
" + "sources": { + "shape": "AwsLogSourceConfigurationList", + "documentation": "Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.
" } } }, @@ -1149,156 +1145,147 @@ "failed": { "shape": "AccountList", "documentation": "Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
" - }, - "processing": { - "shape": "AccountList", - "documentation": "Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.
" } } }, "CreateCustomLogSourceRequest": { "type": "structure", "required": [ - "customSourceName", - "eventClass", - "glueInvocationRoleArn", - "logProviderAccountId" + "sourceName" ], "members": { - "customSourceName": { - "shape": "CustomSourceType", - "documentation": "The name for a third-party custom source. This must be a Regionally unique value.
" + "configuration": { + "shape": "CustomLogSourceConfiguration", + "documentation": "The configuration for the third-party custom source.
" }, - "eventClass": { - "shape": "OcsfEventClass", - "documentation": "The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.
" + "eventClasses": { + "shape": "OcsfEventClassList", + "documentation": "The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:
ACCESS_ACTIVITY
FILE_ACTIVITY
KERNEL_ACTIVITY
KERNEL_EXTENSION
MEMORY_ACTIVITY
MODULE_ACTIVITY
PROCESS_ACTIVITY
REGISTRY_KEY_ACTIVITY
REGISTRY_VALUE_ACTIVITY
RESOURCE_ACTIVITY
SCHEDULED_JOB_ACTIVITY
SECURITY_FINDING
ACCOUNT_CHANGE
AUTHENTICATION
AUTHORIZATION
ENTITY_MANAGEMENT_AUDIT
DHCP_ACTIVITY
NETWORK_ACTIVITY
DNS_ACTIVITY
FTP_ACTIVITY
HTTP_ACTIVITY
RDP_ACTIVITY
SMB_ACTIVITY
SSH_ACTIVITY
CONFIG_STATE
INVENTORY_INFO
EMAIL_ACTIVITY
API_ACTIVITY
CLOUD_API
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:
The managed policy AWSGlueServiceRole
A custom policy granting access to your Amazon S3 Data Lake
Specify the name for a third-party custom source. This must be a Regionally unique value.
" }, - "logProviderAccountId": { - "shape": "AwsAccountId", - "documentation": "The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.
" + "sourceVersion": { + "shape": "CustomLogSourceVersion", + "documentation": "Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
" } } }, "CreateCustomLogSourceResponse": { "type": "structure", - "required": [ - "customDataLocation", - "glueCrawlerName", - "glueDatabaseName", - "glueTableName", - "logProviderAccessRoleArn" - ], "members": { - "customDataLocation": { - "shape": "String", - "documentation": "The location of the partition in the Amazon S3 bucket for Security Lake.
" - }, - "glueCrawlerName": { - "shape": "String", - "documentation": "The name of the Glue crawler.
" - }, - "glueDatabaseName": { - "shape": "String", - "documentation": "The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*
.
The table name of the Glue crawler.
" - }, - "logProviderAccessRoleArn": { - "shape": "String", - "documentation": "The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId
to assume the role.
The created third-party custom source.
" } } }, - "CreateDatalakeAutoEnableRequest": { + "CreateDataLakeExceptionSubscriptionRequest": { "type": "structure", "required": [ - "configurationForNewAccounts" + "notificationEndpoint", + "subscriptionProtocol" ], "members": { - "configurationForNewAccounts": { - "shape": "AutoEnableNewRegionConfigurationList", - "documentation": "Enable Security Lake with the specified configuration settings to begin collecting security data for new accounts in your organization.
" + "exceptionTimeToLive": { + "shape": "CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong", + "documentation": "The expiration period and time-to-live (TTL).
" + }, + "notificationEndpoint": { + "shape": "SafeString", + "documentation": "The Amazon Web Services account where you want to receive exception notifications.
" + }, + "subscriptionProtocol": { + "shape": "SubscriptionProtocol", + "documentation": "The subscription protocol to which exception notifications are posted.
" } } }, - "CreateDatalakeAutoEnableResponse": { + "CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong": { + "type": "long", + "box": true, + "min": 1 + }, + "CreateDataLakeExceptionSubscriptionResponse": { "type": "structure", "members": {} }, - "CreateDatalakeDelegatedAdminRequest": { + "CreateDataLakeOrganizationConfigurationRequest": { "type": "structure", "required": [ - "account" + "autoEnableNewAccount" ], "members": { - "account": { - "shape": "SafeString", - "documentation": "The Amazon Web Services account ID of the Security Lake delegated administrator.
" + "autoEnableNewAccount": { + "shape": "DataLakeAutoEnableNewAccountConfigurationList", + "documentation": "Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
" } } }, - "CreateDatalakeDelegatedAdminResponse": { + "CreateDataLakeOrganizationConfigurationResponse": { "type": "structure", "members": {} }, - "CreateDatalakeExceptionsSubscriptionRequest": { + "CreateDataLakeRequest": { "type": "structure", "required": [ - "notificationEndpoint", - "subscriptionProtocol" + "configurations", + "metaStoreManagerRoleArn" ], "members": { - "notificationEndpoint": { - "shape": "SafeString", - "documentation": "The Amazon Web Services account where you want to receive exception notifications.
" + "configurations": { + "shape": "DataLakeConfigurationList", + "documentation": "Specify the Region or Regions that will contribute data to the rollup region.
" }, - "subscriptionProtocol": { - "shape": "SubscriptionProtocolType", - "documentation": "The subscription protocol to which exception notifications are posted.
" + "metaStoreManagerRoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
" } } }, - "CreateDatalakeExceptionsSubscriptionResponse": { + "CreateDataLakeResponse": { "type": "structure", - "members": {} + "members": { + "dataLakes": { + "shape": "DataLakeResourceList", + "documentation": "The created Security Lake configuration object.
" + } + } }, - "CreateDatalakeRequest": { + "CreateSubscriberNotificationRequest": { "type": "structure", + "required": [ + "configuration", + "subscriberId" + ], "members": { - "configurations": { - "shape": "LakeConfigurationRequestMap", - "documentation": "Specify the Region or Regions that will contribute data to the rollup region.
" + "configuration": { + "shape": "NotificationConfiguration", + "documentation": "Specify the configuration using which you want to create the subscriber notification.
" }, - "enableAll": { - "shape": "Boolean", - "documentation": "Enable Security Lake in all Regions.
" - }, - "metaStoreManagerRoleArn": { - "shape": "RoleArn", - "documentation": "The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
" - }, - "regions": { - "shape": "RegionSet", - "documentation": "Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.
" + "subscriberId": { + "shape": "UUID", + "documentation": "The subscriber ID for the notification subscription.
", + "location": "uri", + "locationName": "subscriberId" } } }, - "CreateDatalakeResponse": { + "CreateSubscriberNotificationResponse": { "type": "structure", - "members": {} + "members": { + "subscriberEndpoint": { + "shape": "SafeString", + "documentation": "The subscriber endpoint to which exception messages are posted.
" + } + } }, "CreateSubscriberRequest": { "type": "structure", "required": [ - "accountId", - "externalId", - "sourceTypes", + "sources", + "subscriberIdentity", "subscriberName" ], "members": { @@ -1306,21 +1293,17 @@ "shape": "AccessTypeList", "documentation": "The Amazon S3 or Lake Formation access type.
" }, - "accountId": { - "shape": "AwsAccountId", - "documentation": "The Amazon Web Services account ID used to access your data.
" - }, - "externalId": { - "shape": "SafeString", - "documentation": "The external ID of the subscriber. This lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.
" - }, - "sourceTypes": { - "shape": "SourceTypeList", + "sources": { + "shape": "LogSourceResourceList", "documentation": "The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.
" }, "subscriberDescription": { "shape": "DescriptionString", - "documentation": "The description for your subscriber account in Security Lake.
" + "documentation": "The description for your subscriber account in Security Lake.
" + }, + "subscriberIdentity": { + "shape": "AwsIdentity", + "documentation": "The AWS identity used to access your data.
" }, "subscriberName": { "shape": "CreateSubscriberRequestSubscriberNameString", @@ -1335,430 +1318,629 @@ }, "CreateSubscriberResponse": { "type": "structure", - "required": [ - "subscriptionId" - ], "members": { - "resourceShareArn": { - "shape": "ResourceShareArn", - "documentation": "The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
" - }, - "resourceShareName": { - "shape": "ResourceShareName", - "documentation": "The name of the resource share.
" - }, - "roleArn": { - "shape": "RoleArn", - "documentation": "The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see Amazon Security Lake User Guide.
" - }, - "s3BucketArn": { - "shape": "S3BucketArn", - "documentation": "The ARN for the Amazon S3 bucket.
" + "subscriber": { + "shape": "SubscriberResource", + "documentation": "Retrieve information about the subscriber created using the CreateSubscriber
API.
The ARN of the Glue crawler.
" }, - "snsArn": { - "shape": "SnsTopicArn", - "documentation": "The ARN for the Amazon Simple Notification Service.
" + "databaseArn": { + "shape": "AmazonResourceName", + "documentation": "The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*
.
The subscriptionId
created by the CreateSubscriber
API call.
The ARN of the Glue table.
" } - } + }, + "documentation": "The attributes of a third-party custom source.
" }, - "CreateSubscriptionNotificationConfigurationRequest": { + "CustomLogSourceConfiguration": { "type": "structure", "required": [ - "subscriptionId" + "crawlerConfiguration", + "providerIdentity" ], "members": { - "createSqs": { - "shape": "Boolean", - "documentation": "Create an Amazon Simple Queue Service queue.
" + "crawlerConfiguration": { + "shape": "CustomLogSourceCrawlerConfiguration", + "documentation": "The configuration for the Glue Crawler for the third-party custom source.
" }, - "httpsApiKeyName": { - "shape": "String", - "documentation": "The key name for the notification subscription.
" - }, - "httpsApiKeyValue": { - "shape": "String", - "documentation": "The key value for the notification subscription.
" - }, - "httpsMethod": { - "shape": "HttpsMethod", - "documentation": "The HTTPS method used for the notification subscription.
" + "providerIdentity": { + "shape": "AwsIdentity", + "documentation": "The identity of the log provider for the third-party custom source.
" + } + }, + "documentation": "The configuration for the third-party custom source.
" + }, + "CustomLogSourceCrawlerConfiguration": { + "type": "structure", + "required": [ + "roleArn" + ], + "members": { + "roleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:
The managed policy AWSGlueServiceRole
A custom policy granting access to your Amazon S3 Data Lake
The configuration for the Glue Crawler for the third-party custom source.
" + }, + "CustomLogSourceName": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[\\\\\\w\\-_:/.]*$" + }, + "CustomLogSourceProvider": { + "type": "structure", + "members": { + "location": { + "shape": "S3URI", + "documentation": "The location of the partition in the Amazon S3 bucket for Security Lake.
" }, "roleArn": { "shape": "RoleArn", - "documentation": "The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.
" + "documentation": "The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId
to assume the role.
The details of the log provider for a third-party custom source.
" + }, + "CustomLogSourceResource": { + "type": "structure", + "members": { + "attributes": { + "shape": "CustomLogSourceAttributes", + "documentation": "The attributes of a third-party custom source.
" }, - "subscriptionEndpoint": { - "shape": "CreateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString", - "documentation": "The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
" + "provider": { + "shape": "CustomLogSourceProvider", + "documentation": "The details of the log provider for a third-party custom source.
" }, - "subscriptionId": { - "shape": "UUID", - "documentation": "The subscription ID for the notification subscription.
", - "location": "uri", - "locationName": "subscriptionId" + "sourceName": { + "shape": "CustomLogSourceName", + "documentation": "The name for a third-party custom source. This must be a Regionally unique value.
" + }, + "sourceVersion": { + "shape": "CustomLogSourceVersion", + "documentation": "The version for a third-party custom source. This must be a Regionally unique value.
" } - } + }, + "documentation": "Amazon Security Lake can collect logs and events from third-party custom sources.
" }, - "CreateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString": { + "CustomLogSourceVersion": { "type": "string", - "pattern": "^(arn:aws:.+$|https?://.+$)" + "max": 32, + "min": 1, + "pattern": "^[A-Za-z0-9\\-\\.\\_]*$" }, - "CreateSubscriptionNotificationConfigurationResponse": { + "DataLakeAutoEnableNewAccountConfiguration": { "type": "structure", + "required": [ + "region", + "sources" + ], "members": { - "queueArn": { - "shape": "SafeString", - "documentation": "Returns the Amazon Resource Name (ARN) of the queue.
" + "region": { + "shape": "Region", + "documentation": "The Amazon Web Services Regions where Security Lake is automatically enabled.
" + }, + "sources": { + "shape": "AwsLogSourceResourceList", + "documentation": "The Amazon Web Services sources that are automatically enabled in Security Lake.
" } - } + }, + "documentation": "Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
" }, - "CustomSourceType": { - "type": "string", - "pattern": "^[\\\\\\w\\-_:/.]*$" + "DataLakeAutoEnableNewAccountConfigurationList": { + "type": "list", + "member": { + "shape": "DataLakeAutoEnableNewAccountConfiguration" + } }, - "DeleteAwsLogSourceRequest": { + "DataLakeConfiguration": { "type": "structure", "required": [ - "inputOrder" + "region" ], "members": { - "disableAllDimensions": { - "shape": "AllDimensionsMap", - "documentation": "Removes the specific Amazon Web Services sources from specific accounts and specific Regions.
" + "encryptionConfiguration": { + "shape": "DataLakeEncryptionConfiguration", + "documentation": "Provides encryption details of Amazon Security Lake object.
" }, - "disableSingleDimension": { - "shape": "InputSet", - "documentation": "Removes all Amazon Web Services sources from specific accounts or Regions.
" + "lifecycleConfiguration": { + "shape": "DataLakeLifecycleConfiguration", + "documentation": "Provides lifecycle details of Amazon Security Lake object.
" }, - "disableTwoDimensions": { - "shape": "TwoDimensionsMap", - "documentation": "Remove a specific Amazon Web Services source from specific accounts or Regions.
" + "region": { + "shape": "Region", + "documentation": "The Amazon Web Services Regions where Security Lake is automatically enabled.
" }, - "inputOrder": { - "shape": "DimensionSet", - "documentation": "This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).
" + "replicationConfiguration": { + "shape": "DataLakeReplicationConfiguration", + "documentation": "Provides replication details of Amazon Security Lake object.
" } + }, + "documentation": "Provides details of Amazon Security Lake object.
" + }, + "DataLakeConfigurationList": { + "type": "list", + "member": { + "shape": "DataLakeConfiguration" } }, - "DeleteAwsLogSourceResponse": { + "DataLakeEncryptionConfiguration": { "type": "structure", "members": { - "failed": { - "shape": "AccountList", - "documentation": "Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
" + "kmsKeyId": { + "shape": "String", + "documentation": "The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
" + } + }, + "documentation": "Provides encryption details of Amazon Security Lake object.
" + }, + "DataLakeException": { + "type": "structure", + "members": { + "exception": { + "shape": "SafeString", + "documentation": "The underlying exception of a Security Lake exception.
" }, - "processing": { - "shape": "AccountList", - "documentation": "Deletion of the Amazon Web Services sources is in progress.
" + "region": { + "shape": "Region", + "documentation": "The Amazon Web Services Regions where the exception occurred.
" + }, + "remediation": { + "shape": "SafeString", + "documentation": "List of all remediation steps for a Security Lake exception.
" + }, + "timestamp": { + "shape": "SyntheticTimestamp_date_time", + "documentation": "This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.
" } + }, + "documentation": "The details for a Security Lake exception
" + }, + "DataLakeExceptionList": { + "type": "list", + "member": { + "shape": "DataLakeException" } }, - "DeleteCustomLogSourceRequest": { + "DataLakeLifecycleConfiguration": { "type": "structure", - "required": [ - "customSourceName" - ], "members": { - "customSourceName": { - "shape": "String", - "documentation": "The custom source name for the custom log source.
", - "location": "querystring", - "locationName": "customSourceName" + "expiration": { + "shape": "DataLakeLifecycleExpiration", + "documentation": "Provides data expiration details of Amazon Security Lake object.
" + }, + "transitions": { + "shape": "DataLakeLifecycleTransitionList", + "documentation": "Provides data storage transition details of Amazon Security Lake object.
" } - } + }, + "documentation": "Provides lifecycle details of Amazon Security Lake object.
" }, - "DeleteCustomLogSourceResponse": { + "DataLakeLifecycleExpiration": { "type": "structure", - "required": [ - "customDataLocation" - ], "members": { - "customDataLocation": { - "shape": "String", - "documentation": "The location of the partition in the Amazon S3 bucket for Security Lake.
" + "days": { + "shape": "DataLakeLifecycleExpirationDaysInteger", + "documentation": "Number of days before data expires in the Amazon Security Lake object.
" } - } + }, + "documentation": "Provide expiration lifecycle details of Amazon Security Lake object.
" + }, + "DataLakeLifecycleExpirationDaysInteger": { + "type": "integer", + "box": true, + "min": 1 }, - "DeleteDatalakeAutoEnableRequest": { + "DataLakeLifecycleTransition": { "type": "structure", - "required": [ - "removeFromConfigurationForNewAccounts" - ], "members": { - "removeFromConfigurationForNewAccounts": { - "shape": "AutoEnableNewRegionConfigurationList", - "documentation": "Remove automatic enablement of configuration settings for new member accounts in Security Lake.
" + "days": { + "shape": "DataLakeLifecycleTransitionDaysInteger", + "documentation": "Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
" + }, + "storageClass": { + "shape": "DataLakeStorageClass", + "documentation": "The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
" } + }, + "documentation": "Provide transition lifecycle details of Amazon Security Lake object.
" + }, + "DataLakeLifecycleTransitionDaysInteger": { + "type": "integer", + "box": true, + "min": 1 + }, + "DataLakeLifecycleTransitionList": { + "type": "list", + "member": { + "shape": "DataLakeLifecycleTransition" } }, - "DeleteDatalakeAutoEnableResponse": { + "DataLakeReplicationConfiguration": { "type": "structure", - "members": {} + "members": { + "regions": { + "shape": "RegionList", + "documentation": "Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
" + }, + "roleArn": { + "shape": "RoleArn", + "documentation": "Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
" + } + }, + "documentation": "Provides replication details of Amazon Security Lake object.
" }, - "DeleteDatalakeDelegatedAdminRequest": { + "DataLakeResource": { "type": "structure", "required": [ - "account" + "dataLakeArn", + "region" ], "members": { - "account": { - "shape": "SafeString", - "documentation": "The account ID the Security Lake delegated administrator.
", - "location": "uri", - "locationName": "account" + "createStatus": { + "shape": "DataLakeStatus", + "documentation": "Retrieves the status of the configuration operation for an account in Amazon Security Lake.
" + }, + "dataLakeArn": { + "shape": "AmazonResourceName", + "documentation": "The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
" + }, + "encryptionConfiguration": { + "shape": "DataLakeEncryptionConfiguration", + "documentation": "Provides encryption details of Amazon Security Lake object.
" + }, + "lifecycleConfiguration": { + "shape": "DataLakeLifecycleConfiguration", + "documentation": "Provides lifecycle details of Amazon Security Lake object.
" + }, + "region": { + "shape": "Region", + "documentation": "The Amazon Web Services Regions where Security Lake is enabled.
" + }, + "replicationConfiguration": { + "shape": "DataLakeReplicationConfiguration", + "documentation": "Provides replication details of Amazon Security Lake object.
" + }, + "s3BucketArn": { + "shape": "S3BucketArn", + "documentation": "The ARN for the Amazon Security Lake Amazon S3 bucket.
" + }, + "updateStatus": { + "shape": "DataLakeUpdateStatus", + "documentation": "The status of the last UpdateDataLake
or DeleteDataLake
API request.
Provides details of Amazon Security Lake object.
" + }, + "DataLakeResourceList": { + "type": "list", + "member": { + "shape": "DataLakeResource" } }, - "DeleteDatalakeDelegatedAdminResponse": { + "DataLakeSource": { "type": "structure", - "members": {} + "members": { + "account": { + "shape": "String", + "documentation": "The ID of the Security Lake account for which logs are collected.
" + }, + "eventClasses": { + "shape": "OcsfEventClassList", + "documentation": "The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:
ACCESS_ACTIVITY
FILE_ACTIVITY
KERNEL_ACTIVITY
KERNEL_EXTENSION
MEMORY_ACTIVITY
MODULE_ACTIVITY
PROCESS_ACTIVITY
REGISTRY_KEY_ACTIVITY
REGISTRY_VALUE_ACTIVITY
RESOURCE_ACTIVITY
SCHEDULED_JOB_ACTIVITY
SECURITY_FINDING
ACCOUNT_CHANGE
AUTHENTICATION
AUTHORIZATION
ENTITY_MANAGEMENT_AUDIT
DHCP_ACTIVITY
NETWORK_ACTIVITY
DNS_ACTIVITY
FTP_ACTIVITY
HTTP_ACTIVITY
RDP_ACTIVITY
SMB_ACTIVITY
SSH_ACTIVITY
CONFIG_STATE
INVENTORY_INFO
EMAIL_ACTIVITY
API_ACTIVITY
CLOUD_API
The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" + }, + "sourceStatuses": { + "shape": "DataLakeSourceStatusList", + "documentation": "The log status for the Security Lake account.
" + } + }, + "documentation": "Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" }, - "DeleteDatalakeExceptionsSubscriptionRequest": { - "type": "structure", - "members": {} + "DataLakeSourceList": { + "type": "list", + "member": { + "shape": "DataLakeSource" + } }, - "DeleteDatalakeExceptionsSubscriptionResponse": { + "DataLakeSourceStatus": { "type": "structure", - "required": [ - "status" - ], "members": { + "resource": { + "shape": "String", + "documentation": "Defines path the stored logs are available which has information on your systems, applications, and services.
" + }, "status": { - "shape": "SafeString", - "documentation": "Retrieves the status of the delete Security Lake operation for an account.
" + "shape": "SourceCollectionStatus", + "documentation": "The health status of services, including error codes and patterns.
" } + }, + "documentation": "Retrieves the Logs status for the Amazon Security Lake account.
" + }, + "DataLakeSourceStatusList": { + "type": "list", + "member": { + "shape": "DataLakeSourceStatus" } }, - "DeleteDatalakeRequest": { + "DataLakeStatus": { + "type": "string", + "enum": [ + "INITIALIZED", + "PENDING", + "COMPLETED", + "FAILED" + ] + }, + "DataLakeStorageClass": { + "type": "string" + }, + "DataLakeUpdateException": { "type": "structure", - "members": {} + "members": { + "code": { + "shape": "String", + "documentation": "The reason code for the exception of the last UpdateDataLake
or DeleteDataLake
API request.
The reason for the exception of the last UpdateDataLake
or DeleteDataLake
API request.
The details of the last UpdateDataLake
or DeleteDataLake
API request which failed.
The details of the last UpdateDataLake
or DeleteDataLake
API request which failed.
The unique ID for the last UpdateDataLake
or DeleteDataLake
API request.
The status of the last UpdateDataLake
or DeleteDataLake
API request that was requested.
The status of the last UpdateDataLake
or DeleteDataLake
API request. This is set to Completed after the configuration is updated, or removed if deletion of the data lake is successful.
A value created by Security Lake that uniquely identifies your DeleteSubscriber
API request.
Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
" } } }, - "DeleteSubscriberResponse": { + "DeleteAwsLogSourceResponse": { "type": "structure", - "members": {} + "members": { + "failed": { + "shape": "AccountList", + "documentation": "Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
" + } + } }, - "DeleteSubscriptionNotificationConfigurationRequest": { + "DeleteCustomLogSourceRequest": { "type": "structure", "required": [ - "subscriptionId" + "sourceName" ], "members": { - "subscriptionId": { - "shape": "UUID", - "documentation": "The ID of the Security Lake subscriber account.
", + "sourceName": { + "shape": "CustomLogSourceName", + "documentation": "The source name of custom log source that you want to delete.
", "location": "uri", - "locationName": "subscriptionId" + "locationName": "sourceName" + }, + "sourceVersion": { + "shape": "CustomLogSourceVersion", + "documentation": "The source version for the third-party custom source. You can limit the custom source removal to the specified source version.
", + "location": "querystring", + "locationName": "sourceVersion" } } }, - "DeleteSubscriptionNotificationConfigurationResponse": { + "DeleteCustomLogSourceResponse": { "type": "structure", "members": {} }, - "DescriptionString": { - "type": "string", - "pattern": "^[\\\\\\w\\s\\-_:/,.@=+]*$" - }, - "Dimension": { - "type": "string", - "enum": [ - "REGION", - "SOURCE_TYPE", - "MEMBER" - ] - }, - "DimensionSet": { - "type": "list", - "member": { - "shape": "Dimension" - } + "DeleteDataLakeExceptionSubscriptionRequest": { + "type": "structure", + "members": {} }, - "EndpointProtocol": { - "type": "string", - "enum": [ - "HTTPS", - "SQS" - ] + "DeleteDataLakeExceptionSubscriptionResponse": { + "type": "structure", + "members": {} }, - "Failures": { + "DeleteDataLakeOrganizationConfigurationRequest": { "type": "structure", "required": [ - "exceptionMessage", - "remediation", - "timestamp" + "autoEnableNewAccount" ], "members": { - "exceptionMessage": { - "shape": "SafeString", - "documentation": "List of all exception messages.
" - }, - "remediation": { - "shape": "SafeString", - "documentation": "List of all remediation steps for failures.
" - }, - "timestamp": { - "shape": "SyntheticTimestamp_date_time", - "documentation": "This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.
" + "autoEnableNewAccount": { + "shape": "DataLakeAutoEnableNewAccountConfigurationList", + "documentation": "Removes the automatic enablement of configuration settings for new member accounts in Security Lake.
" } - }, - "documentation": "List of all failures.
" + } + }, + "DeleteDataLakeOrganizationConfigurationResponse": { + "type": "structure", + "members": {} }, - "FailuresResponse": { + "DeleteDataLakeRequest": { "type": "structure", + "required": [ + "regions" + ], "members": { - "failures": { - "shape": "Failureslist", - "documentation": "List of all failures.
" - }, - "region": { - "shape": "SafeString", - "documentation": "List of Amazon Web Services Regions where the failure occurred.
" + "regions": { + "shape": "RegionList", + "documentation": "The list of Regions where Security Lake is enabled.
" } - }, - "documentation": "Response element for actions that make changes, namely create, update, or delete actions.
" - }, - "FailuresResponseList": { - "type": "list", - "member": { - "shape": "FailuresResponse" } }, - "Failureslist": { - "type": "list", - "member": { - "shape": "Failures" - } - }, - "GetDatalakeAutoEnableRequest": { + "DeleteDataLakeResponse": { "type": "structure", "members": {} }, - "GetDatalakeAutoEnableResponse": { + "DeleteSubscriberNotificationRequest": { "type": "structure", "required": [ - "autoEnableNewAccounts" + "subscriberId" ], "members": { - "autoEnableNewAccounts": { - "shape": "AutoEnableNewRegionConfigurationList", - "documentation": "The configuration for new accounts.
" + "subscriberId": { + "shape": "UUID", + "documentation": "The ID of the Security Lake subscriber account.
", + "location": "uri", + "locationName": "subscriberId" } } }, - "GetDatalakeExceptionsExpiryRequest": { + "DeleteSubscriberNotificationResponse": { "type": "structure", "members": {} }, - "GetDatalakeExceptionsExpiryResponse": { + "DeleteSubscriberRequest": { "type": "structure", "required": [ - "exceptionMessageExpiry" + "subscriberId" ], "members": { - "exceptionMessageExpiry": { - "shape": "Long", - "documentation": "The expiration period and time-to-live (TTL).
" + "subscriberId": { + "shape": "UUID", + "documentation": "A value created by Security Lake that uniquely identifies your DeleteSubscriber
API request.
Retrieves the exception notification subscription information.
" + "exceptionTimeToLive": { + "shape": "Long", + "documentation": "The expiration period and time-to-live (TTL).
" + }, + "notificationEndpoint": { + "shape": "SafeString", + "documentation": "The Amazon Web Services account where you receive exception notifications.
" + }, + "subscriptionProtocol": { + "shape": "SubscriptionProtocol", + "documentation": "The subscription protocol to which exception notifications are posted.
" } } }, - "GetDatalakeRequest": { + "GetDataLakeOrganizationConfigurationRequest": { "type": "structure", "members": {} }, - "GetDatalakeResponse": { + "GetDataLakeOrganizationConfigurationResponse": { "type": "structure", - "required": [ - "configurations" - ], "members": { - "configurations": { - "shape": "LakeConfigurationResponseMap", - "documentation": "Retrieves the Security Lake configuration object.
" + "autoEnableNewAccount": { + "shape": "DataLakeAutoEnableNewAccountConfigurationList", + "documentation": "The configuration for new accounts.
" } } }, - "GetDatalakeStatusRequest": { + "GetDataLakeSourcesRequest": { "type": "structure", "members": { - "accountSet": { - "shape": "InputSet", + "accounts": { + "shape": "AccountList", "documentation": "The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.
" }, - "maxAccountResults": { - "shape": "Integer", + "maxResults": { + "shape": "MaxResults", "documentation": "The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
" }, "nextToken": { - "shape": "SafeString", - "documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + "shape": "NextToken", + "documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" } } }, - "GetDatalakeStatusResponse": { + "GetDataLakeSourcesResponse": { "type": "structure", - "required": [ - "accountSourcesList" - ], "members": { - "accountSourcesList": { - "shape": "AccountSourcesList", + "dataLakeArn": { + "shape": "AmazonResourceName", + "documentation": "The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
" + }, + "dataLakeSources": { + "shape": "DataLakeSourceList", "documentation": "The list of enabled accounts and enabled sources.
" }, "nextToken": { - "shape": "SafeString", - "documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + "shape": "NextToken", + "documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" } } }, "GetSubscriberRequest": { "type": "structure", "required": [ - "id" + "subscriberId" ], "members": { - "id": { - "shape": "String", + "subscriberId": { + "shape": "UUID", "documentation": "A value created by Amazon Security Lake that uniquely identifies your GetSubscriber
API request.
The subscription information for the specified subscription ID.
" + "documentation": "The subscriber information for the specified subscriber ID.
" } } }, - "HttpsMethod": { + "HttpMethod": { "type": "string", "enum": [ "POST", "PUT" ] }, - "InputSet": { - "type": "list", - "member": { - "shape": "SafeString" - } - }, - "Integer": { - "type": "integer", - "box": true - }, - "LakeConfigurationRequest": { + "HttpsNotificationConfiguration": { "type": "structure", + "required": [ + "endpoint", + "targetRoleArn" + ], "members": { - "encryptionKey": { + "authorizationApiKeyName": { "shape": "String", - "documentation": "The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.
" + "documentation": "The key name for the notification subscription.
" }, - "replicationDestinationRegions": { - "shape": "RegionSet", - "documentation": "Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
" + "authorizationApiKeyValue": { + "shape": "String", + "documentation": "The key value for the notification subscription.
" }, - "replicationRoleArn": { - "shape": "RoleArn", - "documentation": "Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
" + "endpoint": { + "shape": "HttpsNotificationConfigurationEndpointString", + "documentation": "The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
" }, - "retentionSettings": { - "shape": "RetentionSettingList", - "documentation": "Retention settings for the destination Amazon S3 buckets.
" + "httpMethod": { + "shape": "HttpMethod", + "documentation": "The HTTPS method used for the notification subscription.
" }, - "tagsMap": { - "shape": "TagsMap", - "documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
" + "targetRoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.
" } }, - "documentation": "Provides details of Amazon Security Lake configuration object.
" + "documentation": "The configurations for HTTPS subscriber notification.
" }, - "LakeConfigurationRequestMap": { - "type": "map", - "key": { - "shape": "Region" - }, - "value": { - "shape": "LakeConfigurationRequest" - } + "HttpsNotificationConfigurationEndpointString": { + "type": "string", + "pattern": "^https?://.+$" }, - "LakeConfigurationResponse": { + "ListDataLakeExceptionsRequest": { "type": "structure", "members": { - "encryptionKey": { - "shape": "String", - "documentation": "The type of encryption key used by secure the Security Lake configuration object.
" - }, - "replicationDestinationRegions": { - "shape": "RegionSet", - "documentation": "Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
" - }, - "replicationRoleArn": { - "shape": "RoleArn", - "documentation": "Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication setting is correct.
" - }, - "retentionSettings": { - "shape": "RetentionSettingList", - "documentation": "Retention settings for the destination Amazon S3 buckets.
" - }, - "s3BucketArn": { - "shape": "S3BucketArn", - "documentation": "Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.
" - }, - "status": { - "shape": "settingsStatus", - "documentation": "Retrieves the status of the configuration operation for an account in Amazon Security Lake.
" + "maxResults": { + "shape": "MaxResults", + "documentation": "List the maximum number of failures in Security Lake.
" }, - "tagsMap": { - "shape": "TagsMap", - "documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
" + "nextToken": { + "shape": "NextToken", + "documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" }, - "updateStatus": { - "shape": "UpdateStatus", - "documentation": "The status of the last UpdateDatalake
or DeleteDatalake
API request.
List the Amazon Web Services Regions from which exceptions are retrieved.
" } - }, - "documentation": "Provides details of Amazon Security Lake lake configuration object.
" - }, - "LakeConfigurationResponseMap": { - "type": "map", - "key": { - "shape": "Region" - }, - "value": { - "shape": "LakeConfigurationResponse" } }, - "LastUpdateFailure": { + "ListDataLakeExceptionsResponse": { "type": "structure", "members": { - "code": { - "shape": "String", - "documentation": "The reason code for the failure of the last UpdateDatalake
or DeleteDatalake
API request.
Lists the failures that cannot be retried in the current Region.
" }, - "reason": { - "shape": "String", - "documentation": "The reason for the failure of the last UpdateDatalake
or DeleteDatalake
API request.
List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" } - }, - "documentation": "The details of the last UpdateDatalake
or DeleteDatalake
API request which failed.
List the maximum number of failures in Security Lake.
" - }, - "nextToken": { - "shape": "SafeString", - "documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" - }, - "regionSet": { - "shape": "RegionSet", - "documentation": "List the Amazon Web Services Regions from which exceptions are retrieved.
" + "regions": { + "shape": "RegionList", + "documentation": "The list of regions where Security Lake is enabled.
", + "location": "querystring", + "locationName": "regions" } } }, - "ListDatalakeExceptionsResponse": { + "ListDataLakesResponse": { "type": "structure", - "required": [ - "nonRetryableFailures" - ], "members": { - "nextToken": { - "shape": "SafeString", - "documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" - }, - "nonRetryableFailures": { - "shape": "FailuresResponseList", - "documentation": "Lists the failures that cannot be retried in the current Region.
" + "dataLakes": { + "shape": "DataLakeResourceList", + "documentation": "Retrieves the Security Lake configuration object.
" } } }, "ListLogSourcesRequest": { "type": "structure", "members": { - "inputOrder": { - "shape": "DimensionSet", - "documentation": "Lists the log sources in input order, namely Region, source type, and member account.
" - }, - "listAllDimensions": { - "shape": "AllDimensionsMap", - "documentation": "List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.
" - }, - "listSingleDimension": { - "shape": "InputSet", - "documentation": "List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.
" - }, - "listTwoDimensions": { - "shape": "TwoDimensionsMap", - "documentation": "Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.
" + "accounts": { + "shape": "AccountList", + "documentation": "The list of Amazon Web Services accounts for which log sources are displayed.
" }, "maxResults": { - "shape": "Integer", + "shape": "MaxResults", "documentation": "The maximum number of accounts for which the log sources are displayed.
" }, "nextToken": { - "shape": "SafeString", + "shape": "NextToken", "documentation": "If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" + }, + "regions": { + "shape": "RegionList", + "documentation": "The list of regions for which log sources are displayed.
" + }, + "sources": { + "shape": "LogSourceResourceList", + "documentation": "The list of sources for which log sources are displayed.
" } } }, "ListLogSourcesResponse": { "type": "structure", - "required": [ - "regionSourceTypesAccountsList" - ], "members": { "nextToken": { - "shape": "String", + "shape": "NextToken", "documentation": "If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" }, - "regionSourceTypesAccountsList": { - "shape": "RegionSourceTypesAccountsList", - "documentation": "Lists the log sources by Regions for enabled Security Lake accounts.
" + "sources": { + "shape": "LogSourceList", + "documentation": "The list of log sources in your organization that send data to the data lake.
" } } }, @@ -1966,13 +2086,13 @@ "type": "structure", "members": { "maxResults": { - "shape": "Integer", + "shape": "MaxResults", "documentation": "The maximum number of accounts for which the configuration is displayed.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { - "shape": "String", + "shape": "NextToken", "documentation": "If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
", "location": "querystring", "locationName": "nextToken" @@ -1981,124 +2101,127 @@ }, "ListSubscribersResponse": { "type": "structure", - "required": [ - "subscribers" - ], "members": { "nextToken": { - "shape": "String", + "shape": "NextToken", "documentation": "If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" }, "subscribers": { - "shape": "SubscriberList", + "shape": "SubscriberResourceList", "documentation": "The subscribers available for the specified Security Lake account ID.
" } } }, - "LogsStatus": { + "LogSource": { "type": "structure", - "required": [ - "healthStatus", - "pathToLogs" - ], "members": { - "healthStatus": { - "shape": "SourceStatus", - "documentation": "The health status of services, including error codes and patterns.
" + "account": { + "shape": "AwsAccountId", + "documentation": "Specify the account from which you want to collect logs.
" }, - "pathToLogs": { - "shape": "String", - "documentation": "Defines path the stored logs are available which has information on your systems, applications, and services.
" + "region": { + "shape": "Region", + "documentation": "Specify the Regions from which you want to collect logs.
" + }, + "sources": { + "shape": "LogSourceResourceList", + "documentation": "Specify the sources from which you want to collect logs.
" } }, - "documentation": "Retrieves the Logs status for the Amazon Security Lake account.
" + "documentation": "Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources.
" + }, + "LogSourceList": { + "type": "list", + "member": { + "shape": "LogSource" + } + }, + "LogSourceResource": { + "type": "structure", + "members": { + "awsLogSource": { + "shape": "AwsLogSourceResource", + "documentation": "Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" + }, + "customLogSource": { + "shape": "CustomLogSourceResource", + "documentation": "Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
" + } + }, + "documentation": "The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
", + "union": true }, - "LogsStatusList": { + "LogSourceResourceList": { "type": "list", "member": { - "shape": "LogsStatus" + "shape": "LogSourceResource" } }, "Long": { "type": "long", "box": true }, - "OcsfEventClass": { + "MaxResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "NextToken": { "type": "string", - "enum": [ - "ACCESS_ACTIVITY", - "FILE_ACTIVITY", - "KERNEL_ACTIVITY", - "KERNEL_EXTENSION", - "MEMORY_ACTIVITY", - "MODULE_ACTIVITY", - "PROCESS_ACTIVITY", - "REGISTRY_KEY_ACTIVITY", - "REGISTRY_VALUE_ACTIVITY", - "RESOURCE_ACTIVITY", - "SCHEDULED_JOB_ACTIVITY", - "SECURITY_FINDING", - "ACCOUNT_CHANGE", - "AUTHENTICATION", - "AUTHORIZATION", - "ENTITY_MANAGEMENT_AUDIT", - "DHCP_ACTIVITY", - "NETWORK_ACTIVITY", - "DNS_ACTIVITY", - "FTP_ACTIVITY", - "HTTP_ACTIVITY", - "RDP_ACTIVITY", - "SMB_ACTIVITY", - "SSH_ACTIVITY", - "CLOUD_API", - "CONTAINER_LIFECYCLE", - "DATABASE_LIFECYCLE", - "CONFIG_STATE", - "CLOUD_STORAGE", - "INVENTORY_INFO", - "RFB_ACTIVITY", - "SMTP_ACTIVITY", - "VIRTUAL_MACHINE_ACTIVITY" - ] + "pattern": "^[\\\\\\w\\-_:/.@=+]*$" }, - "ProtocolAndNotificationEndpoint": { + "NotificationConfiguration": { "type": "structure", "members": { - "endpoint": { - "shape": "SafeString", - "documentation": "The account that is subscribed to receive exception notifications.
" + "httpsNotificationConfiguration": { + "shape": "HttpsNotificationConfiguration", + "documentation": "The configurations for HTTPS subscriber notification.
" }, - "protocol": { - "shape": "SafeString", - "documentation": "The protocol to which notification messages are posted.
" + "sqsNotificationConfiguration": { + "shape": "SqsNotificationConfiguration", + "documentation": "The configurations for SQS subscriber notification.
" } }, - "documentation": "Protocol used in Amazon Security Lake that dictates how notifications are posted at the endpoint.
" + "documentation": "Specify the configurations you want to use for subscriber notification to notify the subscriber when new data is written to the data lake for sources that the subscriber consumes in Security Lake.
", + "union": true }, - "Region": { + "OcsfEventClass": { "type": "string", - "enum": [ - "us-east-1", - "us-west-2", - "eu-central-1", - "us-east-2", - "eu-west-1", - "ap-northeast-1", - "ap-southeast-2" - ] + "pattern": "^[A-Z\\_0-9]*$" }, - "RegionSet": { + "OcsfEventClassList": { "type": "list", "member": { - "shape": "Region" + "shape": "OcsfEventClass" } }, - "RegionSourceTypesAccountsList": { + "Region": { + "type": "string", + "pattern": "^(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\\d+$" + }, + "RegionList": { "type": "list", "member": { - "shape": "AllDimensionsMap" + "shape": "Region" + } + }, + "RegisterDataLakeDelegatedAdministratorRequest": { + "type": "structure", + "required": [ + "accountId" + ], + "members": { + "accountId": { + "shape": "SafeString", + "documentation": "The Amazon Web Services account ID of the Security Lake delegated administrator.
" + } } }, + "RegisterDataLakeDelegatedAdministratorResponse": { + "type": "structure", + "members": {} + }, "ResourceShareArn": { "type": "string" }, @@ -2106,118 +2229,57 @@ "type": "string", "pattern": "^LakeFormation(?:-V[0-9]+)-([a-zA-Z0-9]+)-([\\\\\\w\\-_:/.@=+]*)$" }, - "RetentionSetting": { - "type": "structure", - "members": { - "retentionPeriod": { - "shape": "RetentionSettingRetentionPeriodInteger", - "documentation": "The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.
" - }, - "storageClass": { - "shape": "StorageClass", - "documentation": "The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
" - } - }, - "documentation": "Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.
" - }, - "RetentionSettingList": { - "type": "list", - "member": { - "shape": "RetentionSetting" - } - }, - "RetentionSettingRetentionPeriodInteger": { - "type": "integer", - "box": true, - "min": 1 - }, "RoleArn": { "type": "string", - "pattern": "^arn:.*" + "pattern": "^arn:.*$" }, "S3BucketArn": { "type": "string" }, + "S3URI": { + "type": "string", + "documentation": "A complete S3 URI pointing to a valid S3 object.
", + "max": 1024, + "min": 0, + "pattern": "^s3[an]?://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/[^/].*)+$" + }, "SafeString": { "type": "string", "pattern": "^[\\\\\\w\\-_:/.@=+]*$" }, - "SnsTopicArn": { - "type": "string" - }, - "SourceStatus": { + "SourceCollectionStatus": { "type": "string", "enum": [ - "ACTIVE", - "DEACTIVATED", - "PENDING" + "COLLECTING", + "MISCONFIGURED", + "NOT_COLLECTING" ] }, - "SourceType": { + "SqsNotificationConfiguration": { "type": "structure", - "members": { - "awsSourceType": { - "shape": "AwsLogSourceType", - "documentation": "Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" - }, - "customSourceType": { - "shape": "CustomSourceType", - "documentation": "Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
" - } - }, - "documentation": "The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
", - "union": true - }, - "SourceTypeList": { - "type": "list", - "member": { - "shape": "SourceType" - } - }, - "StorageClass": { - "type": "string", - "enum": [ - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER_IR", - "GLACIER", - "DEEP_ARCHIVE", - "EXPIRE" - ] + "members": {}, + "documentation": "The configurations for SQS subscriber notification.
" }, "String": { "type": "string" }, - "SubscriberList": { - "type": "list", - "member": { - "shape": "SubscriberResource" - } - }, "SubscriberResource": { "type": "structure", "required": [ - "accountId", - "sourceTypes", - "subscriptionId" + "sources", + "subscriberArn", + "subscriberId", + "subscriberIdentity", + "subscriberName" ], "members": { "accessTypes": { "shape": "AccessTypeList", - "documentation": "You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION
.
The Amazon Web Services account ID you are using to create your Amazon Security Lake account.
" + "documentation": "You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION
.
The date and time when the subscription was created.
" - }, - "externalId": { - "shape": "SafeString", - "documentation": "The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.
" + "documentation": "The date and time when the subscriber was created.
" }, "resourceShareArn": { "shape": "ResourceShareArn", @@ -2233,62 +2295,54 @@ }, "s3BucketArn": { "shape": "S3BucketArn", - "documentation": "The ARN for the Amazon S3 bucket.
" + "documentation": "The ARN for the Amazon S3 bucket.
" }, - "snsArn": { - "shape": "SnsTopicArn", - "documentation": "The ARN for the Amazon Simple Notification Service.
" - }, - "sourceTypes": { - "shape": "SourceTypeList", + "sources": { + "shape": "LogSourceResourceList", "documentation": "Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
" }, + "subscriberArn": { + "shape": "AmazonResourceName", + "documentation": "The subscriber ARN of the Amazon Security Lake subscriber account.
" + }, "subscriberDescription": { "shape": "SafeString", - "documentation": "The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName
, accountID
, externalID
, and subscriptionId
.
The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName
, accountID
, externalID
, and subscriberId
.
The name of your Amazon Security Lake subscriber account.
" - }, - "subscriptionEndpoint": { - "shape": "String", - "documentation": "The subscription endpoint to which exception messages are posted.
" + "documentation": "The subscriber endpoint to which exception messages are posted.
" }, - "subscriptionId": { + "subscriberId": { "shape": "UUID", - "documentation": "The subscription ID of the Amazon Security Lake subscriber account.
" + "documentation": "The subscriber ID of the Amazon Security Lake subscriber account.
" }, - "subscriptionProtocol": { - "shape": "EndpointProtocol", - "documentation": "The subscription protocol to which exception messages are posted.
" + "subscriberIdentity": { + "shape": "AwsIdentity", + "documentation": "The AWS identity used to access your data.
" + }, + "subscriberName": { + "shape": "SafeString", + "documentation": "The name of your Amazon Security Lake subscriber account.
" }, - "subscriptionStatus": { - "shape": "SubscriptionStatus", - "documentation": "The subscription status of the Amazon Security Lake subscriber account.
" + "subscriberStatus": { + "shape": "SubscriberStatus", + "documentation": "The subscriber status of the Amazon Security Lake subscriber account.
" }, "updatedAt": { "shape": "SyntheticTimestamp_date_time", - "documentation": "The date and time when the subscription was created.
" + "documentation": "The date and time when the subscriber was last updated.
" } }, - "documentation": "Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
" + "documentation": "Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
" }, - "SubscriptionProtocolType": { - "type": "string", - "enum": [ - "HTTP", - "HTTPS", - "EMAIL", - "EMAIL_JSON", - "SMS", - "SQS", - "LAMBDA", - "APP", - "FIREHOSE" - ] + "SubscriberResourceList": { + "type": "list", + "member": { + "shape": "SubscriberResource" + } }, - "SubscriptionStatus": { + "SubscriberStatus": { "type": "string", "enum": [ "ACTIVE", @@ -2297,136 +2351,124 @@ "READY" ] }, + "SubscriptionProtocol": { + "type": "string", + "pattern": "^[a-z\\-]*$" + }, "SyntheticTimestamp_date_time": { "type": "timestamp", "timestampFormat": "iso8601" }, - "TagsMap": { - "type": "map", - "key": { - "shape": "String" - }, - "value": { - "shape": "String" - } - }, - "TwoDimensionsMap": { - "type": "map", - "key": { - "shape": "String" - }, - "value": { - "shape": "ValueSet" - } - }, "UUID": { "type": "string", - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, - "UpdateDatalakeExceptionsExpiryRequest": { + "UpdateDataLakeExceptionSubscriptionRequest": { "type": "structure", "required": [ - "exceptionMessageExpiry" + "notificationEndpoint", + "subscriptionProtocol" ], "members": { - "exceptionMessageExpiry": { - "shape": "UpdateDatalakeExceptionsExpiryRequestExceptionMessageExpiryLong", + "exceptionTimeToLive": { + "shape": "UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong", "documentation": "The time-to-live (TTL) for the exception message to remain.
" + }, + "notificationEndpoint": { + "shape": "SafeString", + "documentation": "The account that is subscribed to receive exception notifications.
" + }, + "subscriptionProtocol": { + "shape": "SubscriptionProtocol", + "documentation": "The subscription protocol to which exception messages are posted.
" } } }, - "UpdateDatalakeExceptionsExpiryRequestExceptionMessageExpiryLong": { + "UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong": { "type": "long", "box": true, "min": 1 }, - "UpdateDatalakeExceptionsExpiryResponse": { + "UpdateDataLakeExceptionSubscriptionResponse": { "type": "structure", "members": {} }, - "UpdateDatalakeExceptionsSubscriptionRequest": { + "UpdateDataLakeRequest": { "type": "structure", "required": [ - "notificationEndpoint", - "subscriptionProtocol" + "configurations" ], "members": { - "notificationEndpoint": { - "shape": "SafeString", - "documentation": "The account that is subscribed to receive exception notifications.
" - }, - "subscriptionProtocol": { - "shape": "SubscriptionProtocolType", - "documentation": "The subscription protocol to which exception messages are posted.
" + "configurations": { + "shape": "DataLakeConfigurationList", + "documentation": "Specify the Region or Regions that will contribute data to the rollup region.
" } } }, - "UpdateDatalakeExceptionsSubscriptionResponse": { + "UpdateDataLakeResponse": { "type": "structure", - "members": {} + "members": { + "dataLakes": { + "shape": "DataLakeResourceList", + "documentation": "The created Security Lake configuration object.
" + } + } }, - "UpdateDatalakeRequest": { + "UpdateSubscriberNotificationRequest": { "type": "structure", "required": [ - "configurations" + "configuration", + "subscriberId" ], "members": { - "configurations": { - "shape": "LakeConfigurationRequestMap", - "documentation": "Specify the Region or Regions that will contribute data to the rollup region.
" + "configuration": { + "shape": "NotificationConfiguration", + "documentation": "The configuration for subscriber notification.
" + }, + "subscriberId": { + "shape": "UUID", + "documentation": "The subscription ID for which the subscription notification is specified.
", + "location": "uri", + "locationName": "subscriberId" } } }, - "UpdateDatalakeResponse": { - "type": "structure", - "members": {} - }, - "UpdateStatus": { + "UpdateSubscriberNotificationResponse": { "type": "structure", "members": { - "lastUpdateFailure": { - "shape": "LastUpdateFailure", - "documentation": "The details of the last UpdateDatalake
or DeleteDatalake
API request which failed.
The unique ID for the UpdateDatalake
or DeleteDatalake
API request.
The status of the last UpdateDatalake
or DeleteDatalake
API request that was requested.
The subscriber endpoint to which exception messages are posted.
" } - }, - "documentation": "The status of the last UpdateDatalake
or DeleteDatalake
API request. This is set to Completed after the configuration is updated, or removed if deletion of the data lake is successful.
The external ID of the Security Lake account.
" - }, - "id": { - "shape": "String", - "documentation": "A value created by Security Lake that uniquely identifies your subscription.
", - "location": "uri", - "locationName": "id" - }, - "sourceTypes": { - "shape": "SourceTypeList", + "sources": { + "shape": "LogSourceResourceList", "documentation": "The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" }, "subscriberDescription": { "shape": "DescriptionString", "documentation": "The description of the Security Lake account subscriber.
" }, + "subscriberId": { + "shape": "UUID", + "documentation": "A value created by Security Lake that uniquely identifies your subscription.
", + "location": "uri", + "locationName": "subscriberId" + }, + "subscriberIdentity": { + "shape": "AwsIdentity", + "documentation": "The AWS identity used to access your data.
" + }, "subscriberName": { "shape": "UpdateSubscriberRequestSubscriberNameString", - "documentation": "The name of the Security Lake account subscriber.
" + "documentation": "The name of the Security Lake account subscriber.
" } } }, @@ -2441,76 +2483,10 @@ "members": { "subscriber": { "shape": "SubscriberResource", - "documentation": "The account of the subscriber.
" - } - } - }, - "UpdateSubscriptionNotificationConfigurationRequest": { - "type": "structure", - "required": [ - "subscriptionId" - ], - "members": { - "createSqs": { - "shape": "Boolean", - "documentation": "Create a new subscription notification for the specified subscription ID in Amazon Security Lake.
" - }, - "httpsApiKeyName": { - "shape": "String", - "documentation": "The key name for the subscription notification.
" - }, - "httpsApiKeyValue": { - "shape": "String", - "documentation": "The key value for the subscription notification.
" - }, - "httpsMethod": { - "shape": "HttpsMethod", - "documentation": "The HTTPS method used for the subscription notification.
" - }, - "roleArn": { - "shape": "RoleArn", - "documentation": "The Amazon Resource Name (ARN) specifying the role of the subscriber. For more information about ARNs and how to use them in policies, see, see the Managing data access and Amazon Web Services Managed Policiesin the Amazon Security Lake User Guide.
" - }, - "subscriptionEndpoint": { - "shape": "UpdateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString", - "documentation": "The subscription endpoint in Security Lake.
" - }, - "subscriptionId": { - "shape": "UUID", - "documentation": "The subscription ID for which the subscription notification is specified.
", - "location": "uri", - "locationName": "subscriptionId" - } - } - }, - "UpdateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString": { - "type": "string", - "pattern": "^(arn:aws:.+$|https?://.+$)" - }, - "UpdateSubscriptionNotificationConfigurationResponse": { - "type": "structure", - "members": { - "queueArn": { - "shape": "SafeString", - "documentation": "Returns the ARN of the queue.
" + "documentation": "The updated subscriber information.
" } } - }, - "ValueSet": { - "type": "list", - "member": { - "shape": "String" - } - }, - "settingsStatus": { - "type": "string", - "enum": [ - "INITIALIZED", - "PENDING", - "COMPLETED", - "FAILED" - ] } }, - "documentation": "Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to Section 2 of the Amazon Web Services Service Terms(\"Betas and Previews\").
Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
" + "documentation": "Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Services account. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
" } \ No newline at end of file diff --git a/apis/securitylake-2018-05-10.paginators.json b/apis/securitylake-2018-05-10.paginators.json index 4720717302..19e482b211 100644 --- a/apis/securitylake-2018-05-10.paginators.json +++ b/apis/securitylake-2018-05-10.paginators.json @@ -1,22 +1,22 @@ { "pagination": { - "GetDatalakeStatus": { + "GetDataLakeSources": { "input_token": "nextToken", "output_token": "nextToken", - "limit_key": "maxAccountResults", - "result_key": "accountSourcesList" + "limit_key": "maxResults", + "result_key": "dataLakeSources" }, - "ListDatalakeExceptions": { + "ListDataLakeExceptions": { "input_token": "nextToken", "output_token": "nextToken", - "limit_key": "maxFailures", - "result_key": "nonRetryableFailures" + "limit_key": "maxResults", + "result_key": "exceptions" }, "ListLogSources": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", - "result_key": "regionSourceTypesAccountsList" + "result_key": "sources" }, "ListSubscribers": { "input_token": "nextToken", diff --git a/apis/servicecatalog-2015-12-10.normal.json b/apis/servicecatalog-2015-12-10.normal.json index 743a4efa99..a52a1e12cf 100644 --- a/apis/servicecatalog-2015-12-10.normal.json +++ b/apis/servicecatalog-2015-12-10.normal.json @@ -1047,7 +1047,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Disassociates a previously associated principal ARN from a specified portfolio.
The PrincipalType
and PrincipalARN
must match the AssociatePrincipalWithPortfolio
call request details. For example, to disassociate an association created with a PrincipalARN
of PrincipalType
IAM you must use the PrincipalType
IAM when calling DisassociatePrincipalFromPortfolio
.
For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
" + "documentation": "Disassociates a previously associated principal ARN from a specified portfolio.
The PrincipalType
and PrincipalARN
must match the AssociatePrincipalWithPortfolio
call request details. For example, to disassociate an association created with a PrincipalARN
of PrincipalType
IAM you must use the PrincipalType
IAM when calling DisassociatePrincipalFromPortfolio
.
For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
If you disassociate a principal from a portfolio, with PrincipalType as IAM
, the same principal will still have access to the portfolio if it matches one of the associated principals of type IAM_PATTERN
. To fully remove access for a principal, verify all the associated Principals of type IAM_PATTERN
, and then ensure you disassociate any IAM_PATTERN
principals that match the principal whose access you are removing.
The ARN of the principal (user, role, or group). This field allows an ARN with no accountID
if PrincipalType
is IAM_PATTERN
.
You can associate multiple IAM
patterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio.
The ARN of the principal (user, role, or group). The supported value is a fully defined IAM
ARN if the PrincipalType
is IAM
. If the PrincipalType
is IAM_PATTERN
, the supported value is an IAM
ARN without an AccountID in the following format:
arn:partition:iam:::resource-type/resource-id
The resource-id can be either of the following:
Fully formed, for example arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name
A wildcard ARN. The wildcard ARN accepts IAM_PATTERN
values with a \"*\" or \"?\" in the resource-id segment of the ARN, for example arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are exclusive to the resource-path and resource-name and cannot be used to replace the resource-type or other ARN values.
Examples of an acceptable wildcard ARN:
arn:aws:iam:::role/ResourceName_*
arn:aws:iam:::role/*/ResourceName_?
Examples of an unacceptable wildcard ARN:
arn:aws:iam:::*/ResourceName
You can associate multiple IAM_PATTERN
s even if the account has no principal with that name.
The ARN path and principal name allow unlimited wildcard characters.
The \"?\" wildcard character matches zero or one of any character. This is similar to \".?\" in regular regex context.
The \"*\" wildcard character matches any number of any characters. This is similar \".*\" in regular regex context.
In the IAM Principal ARNs format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The \"?\" and \"*\" are allowed only after the resource-type, in the resource-id segment. You can use special characters anywhere within the resource-id.
The \"*\" also matches the \"/\" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.
The principal type. The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you use an ARN with no accountID
.
The principal type. The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you use an ARN with no accountID
, with or without wildcard characters.
The ARN of the principal (user, role, or group). This field allows an ARN with no accountID
if PrincipalType
is IAM_PATTERN
.
The ARN of the principal (user, role, or group). This field allows an ARN with no accountID
with or without wildcard characters if PrincipalType
is IAM_PATTERN
.
The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you use no accountID
.
The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you specify an IAM
ARN with no AccountId, with or without wildcard characters.
The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID
if the PrincipalType
is an IAM_PATTERN
.
The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID
, with or without wildcard characters if the PrincipalType
is an IAM_PATTERN
.
For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
" }, "PrincipalType": { "shape": "PrincipalType", - "documentation": "The principal type. The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you use an ARN with no accountID
.
The principal type. The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
if you use an ARN with no accountID
, with or without wildcard characters.
Information about a principal.
" diff --git a/apis/wafv2-2019-07-29.min.json b/apis/wafv2-2019-07-29.min.json index 52cb0be810..759618d61b 100644 --- a/apis/wafv2-2019-07-29.min.json +++ b/apis/wafv2-2019-07-29.min.json @@ -90,10 +90,10 @@ "Description": {}, "IPAddressVersion": {}, "Addresses": { - "shape": "S4b" + "shape": "S4c" }, "Tags": { - "shape": "S4d" + "shape": "S4e" } } }, @@ -101,7 +101,7 @@ "type": "structure", "members": { "Summary": { - "shape": "S4i" + "shape": "S4j" } } } @@ -119,10 +119,10 @@ "Scope": {}, "Description": {}, "RegularExpressionList": { - "shape": "S4m" + "shape": "S4n" }, "Tags": { - "shape": "S4d" + "shape": "S4e" } } }, @@ -130,7 +130,7 @@ "type": "structure", "members": { "Summary": { - "shape": "S4p" + "shape": "S4q" } } } @@ -155,13 +155,13 @@ "shape": "S6" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "Tags": { - "shape": "S4d" + "shape": "S4e" }, "CustomResponseBodies": { - "shape": "S4s" + "shape": "S4t" } } }, @@ -169,7 +169,7 @@ "type": "structure", "members": { "Summary": { - "shape": "S4x" + "shape": "S4y" } } } @@ -187,32 +187,32 @@ "Name": {}, "Scope": {}, "DefaultAction": { - "shape": "S4z" + "shape": "S50" }, "Description": {}, "Rules": { "shape": "S6" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "Tags": { - "shape": "S4d" + "shape": "S4e" }, "CustomResponseBodies": { - "shape": "S4s" + "shape": "S4t" }, "CaptchaConfig": { - "shape": "S3x" + "shape": "S3y" }, "ChallengeConfig": { - "shape": "S40" + "shape": "S41" }, "TokenDomains": { - "shape": "S50" + "shape": "S51" }, "AssociationConfig": { - "shape": "S51" + "shape": "S52" } } }, @@ -220,7 +220,7 @@ "type": "structure", "members": { "Summary": { - "shape": "S57" + "shape": "S58" } } } @@ -358,6 +358,46 @@ "members": {} } }, + "DescribeAllManagedProducts": { + "input": { + "type": "structure", + "required": [ + "Scope" + ], + "members": { + "Scope": {} + } + }, + "output": { + "type": "structure", + "members": { + "ManagedProducts": { + "shape": "S5p" + } + } + } + }, + "DescribeManagedProductsByVendor": { + "input": { + "type": "structure", + "required": [ + "VendorName", + "Scope" + ], + "members": { + "VendorName": {}, + "Scope": {} + } + }, + "output": { + "type": "structure", + "members": { + "ManagedProducts": { + "shape": "S5p" + } + } + } + }, "DescribeManagedRuleGroup": { "input": { "type": "structure", @@ -388,17 +428,17 @@ "members": { "Name": {}, "Action": { - "shape": "S1o" + "shape": "S1p" } } } }, "LabelNamespace": {}, "AvailableLabels": { - "shape": "S5q" + "shape": "S61" }, "ConsumedLabels": { - "shape": "S5q" + "shape": "S61" } } } @@ -453,7 +493,7 @@ "type": "structure", "members": { "TokenDomains": { - "shape": "S50" + "shape": "S51" }, "CreationTimestamp": { "type": "timestamp" @@ -494,7 +534,7 @@ "Description": {}, "IPAddressVersion": {}, "Addresses": { - "shape": "S4b" + "shape": "S4c" } } }, @@ -516,7 +556,7 @@ "type": "structure", "members": { "LoggingConfiguration": { - "shape": "S66" + "shape": "S6h" } } } @@ -607,7 +647,7 @@ }, "ReleaseNotes": {}, "Tags": { - "shape": "S4d" + "shape": "S4e" } } } @@ -652,10 +692,10 @@ "type": "structure", "members": { "ManagedKeysIPV4": { - "shape": "S6y" + "shape": "S79" }, "ManagedKeysIPV6": { - "shape": "S6y" + "shape": "S79" } } } @@ -685,7 +725,7 @@ "ARN": {}, "Description": {}, "RegularExpressionList": { - "shape": "S4m" + "shape": "S4n" } } }, @@ -727,17 +767,17 @@ "shape": "S6" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "LabelNamespace": {}, "CustomResponseBodies": { - "shape": "S4s" + "shape": "S4t" }, "AvailableLabels": { - "shape": "S5q" + "shape": "S61" }, "ConsumedLabels": { - "shape": "S5q" + "shape": "S61" } } }, @@ -760,7 +800,7 @@ "RuleMetricName": {}, "Scope": {}, "TimeWindow": { - "shape": "S76" + "shape": "S7h" }, "MaxItems": { "type": "long" @@ -788,7 +828,7 @@ "Method": {}, "HTTPVersion": {}, "Headers": { - "shape": "S7h" + "shape": "S7s" } } }, @@ -801,13 +841,13 @@ "Action": {}, "RuleNameWithinRuleGroup": {}, "RequestHeadersInserted": { - "shape": "S7h" + "shape": "S7s" }, "ResponseCodeSent": { "type": "integer" }, "Labels": { - "shape": "S3r" + "shape": "S3s" }, "CaptchaResponse": { "type": "structure", @@ -841,7 +881,7 @@ "type": "long" }, "TimeWindow": { - "shape": "S76" + "shape": "S7h" } } } @@ -864,7 +904,7 @@ "type": "structure", "members": { "WebACL": { - "shape": "S7v" + "shape": "S86" }, "LockToken": {}, "ApplicationIntegrationURL": {} @@ -885,7 +925,7 @@ "type": "structure", "members": { "WebACL": { - "shape": "S7v" + "shape": "S86" } } } @@ -914,7 +954,7 @@ "type": "structure", "members": { "TokenDomains": { - "shape": "S50" + "shape": "S51" }, "APIKey": {}, "CreationTimestamp": { @@ -1024,7 +1064,7 @@ "IPSets": { "type": "list", "member": { - "shape": "S4i" + "shape": "S4j" } } } @@ -1050,7 +1090,7 @@ "LoggingConfigurations": { "type": "list", "member": { - "shape": "S66" + "shape": "S6h" } }, "NextMarker": {} @@ -1146,7 +1186,7 @@ "RegexPatternSets": { "type": "list", "member": { - "shape": "S4p" + "shape": "S4q" } } } @@ -1194,7 +1234,7 @@ "RuleGroups": { "type": "list", "member": { - "shape": "S4x" + "shape": "S4y" } } } @@ -1223,7 +1263,7 @@ "members": { "ResourceARN": {}, "TagList": { - "shape": "S4d" + "shape": "S4e" } } } @@ -1251,7 +1291,7 @@ "WebACLs": { "type": "list", "member": { - "shape": "S57" + "shape": "S58" } } } @@ -1265,7 +1305,7 @@ ], "members": { "LoggingConfiguration": { - "shape": "S66" + "shape": "S6h" } } }, @@ -1273,7 +1313,7 @@ "type": "structure", "members": { "LoggingConfiguration": { - "shape": "S66" + "shape": "S6h" } } } @@ -1342,7 +1382,7 @@ "members": { "ResourceARN": {}, "Tags": { - "shape": "S4d" + "shape": "S4e" } } }, @@ -1387,7 +1427,7 @@ "Id": {}, "Description": {}, "Addresses": { - "shape": "S4b" + "shape": "S4c" }, "LockToken": {} } @@ -1448,7 +1488,7 @@ "Id": {}, "Description": {}, "RegularExpressionList": { - "shape": "S4m" + "shape": "S4n" }, "LockToken": {} } @@ -1479,11 +1519,11 @@ "shape": "S6" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "LockToken": {}, "CustomResponseBodies": { - "shape": "S4s" + "shape": "S4t" } } }, @@ -1510,30 +1550,30 @@ "Scope": {}, "Id": {}, "DefaultAction": { - "shape": "S4z" + "shape": "S50" }, "Description": {}, "Rules": { "shape": "S6" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "LockToken": {}, "CustomResponseBodies": { - "shape": "S4s" + "shape": "S4t" }, "CaptchaConfig": { - "shape": "S3x" + "shape": "S3y" }, "ChallengeConfig": { - "shape": "S40" + "shape": "S41" }, "TokenDomains": { - "shape": "S50" + "shape": "S51" }, "AssociationConfig": { - "shape": "S51" + "shape": "S52" } } }, @@ -1565,22 +1605,22 @@ "shape": "Sa" }, "Action": { - "shape": "S1o" + "shape": "S1p" }, "OverrideAction": { - "shape": "S3p" + "shape": "S3q" }, "RuleLabels": { - "shape": "S3r" + "shape": "S3s" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "CaptchaConfig": { - "shape": "S3x" + "shape": "S3y" }, "ChallengeConfig": { - "shape": "S40" + "shape": "S41" } } } @@ -1604,7 +1644,7 @@ "shape": "Sd" }, "TextTransformations": { - "shape": "S12" + "shape": "S13" }, "PositionalConstraint": {} } @@ -1620,7 +1660,7 @@ "shape": "Sd" }, "TextTransformations": { - "shape": "S12" + "shape": "S13" }, "SensitivityLevel": {} } @@ -1636,7 +1676,7 @@ "shape": "Sd" }, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1657,7 +1697,7 @@ "type": "long" }, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1669,12 +1709,12 @@ "member": {} }, "ForwardedIPConfig": { - "shape": "S1g" + "shape": "S1h" } } }, "RuleGroupReferenceStatement": { - "shape": "S1j" + "shape": "S1k" }, "IPSetReferenceStatement": { "type": "structure", @@ -1711,7 +1751,7 @@ "shape": "Sd" }, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1730,7 +1770,7 @@ "shape": "Sa" }, "ForwardedIPConfig": { - "shape": "S1g" + "shape": "S1h" }, "CustomKeys": { "type": "list", @@ -1746,7 +1786,7 @@ "members": { "Name": {}, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1759,7 +1799,7 @@ "members": { "Name": {}, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1772,7 +1812,7 @@ "members": { "Name": {}, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1783,7 +1823,7 @@ ], "members": { "TextTransformations": { - "shape": "S12" + "shape": "S13" } } }, @@ -1820,7 +1860,7 @@ ], "members": { "Statements": { - "shape": "S2k" + "shape": "S2l" } } }, @@ -1831,7 +1871,7 @@ ], "members": { "Statements": { - "shape": "S2k" + "shape": "S2l" } } }, @@ -1847,7 +1887,7 @@ } }, "ManagedRuleGroupStatement": { - "shape": "S2n" + "shape": "S2o" }, "LabelMatchStatement": { "type": "structure", @@ -1873,7 +1913,7 @@ "shape": "Sd" }, "TextTransformations": { - "shape": "S12" + "shape": "S13" } } } @@ -1997,6 +2037,15 @@ "MatchScope": {}, "OversizeHandling": {} } + }, + "HeaderOrder": { + "type": "structure", + "required": [ + "OversizeHandling" + ], + "members": { + "OversizeHandling": {} + } } } }, @@ -2012,7 +2061,7 @@ "type": "list", "member": {} }, - "S12": { + "S13": { "type": "list", "member": { "type": "structure", @@ -2028,7 +2077,7 @@ } } }, - "S1g": { + "S1h": { "type": "structure", "required": [ "HeaderName", @@ -2039,7 +2088,7 @@ "FallbackBehavior": {} } }, - "S1j": { + "S1k": { "type": "structure", "required": [ "ARN" @@ -2047,14 +2096,14 @@ "members": { "ARN": {}, "ExcludedRules": { - "shape": "S1k" + "shape": "S1l" }, "RuleActionOverrides": { - "shape": "S1m" + "shape": "S1n" } } }, - "S1k": { + "S1l": { "type": "list", "member": { "type": "structure", @@ -2066,7 +2115,7 @@ } } }, - "S1m": { + "S1n": { "type": "list", "member": { "type": "structure", @@ -2077,28 +2126,28 @@ "members": { "Name": {}, "ActionToUse": { - "shape": "S1o" + "shape": "S1p" } } } }, - "S1o": { + "S1p": { "type": "structure", "members": { "Block": { - "shape": "S1p" + "shape": "S1q" }, "Allow": { - "shape": "S1w" + "shape": "S1x" }, "Count": { - "shape": "S1y" + "shape": "S1z" }, "Captcha": { "type": "structure", "members": { "CustomRequestHandling": { - "shape": "S1x" + "shape": "S1y" } } }, @@ -2106,13 +2155,13 @@ "type": "structure", "members": { "CustomRequestHandling": { - "shape": "S1x" + "shape": "S1y" } } } } }, - "S1p": { + "S1q": { "type": "structure", "members": { "CustomResponse": { @@ -2126,13 +2175,13 @@ }, "CustomResponseBodyKey": {}, "ResponseHeaders": { - "shape": "S1s" + "shape": "S1t" } } } } }, - "S1s": { + "S1t": { "type": "list", "member": { "type": "structure", @@ -2146,40 +2195,40 @@ } } }, - "S1w": { + "S1x": { "type": "structure", "members": { "CustomRequestHandling": { - "shape": "S1x" + "shape": "S1y" } } }, - "S1x": { + "S1y": { "type": "structure", "required": [ "InsertHeaders" ], "members": { "InsertHeaders": { - "shape": "S1s" + "shape": "S1t" } } }, - "S1y": { + "S1z": { "type": "structure", "members": { "CustomRequestHandling": { - "shape": "S1x" + "shape": "S1y" } } }, - "S2k": { + "S2l": { "type": "list", "member": { "shape": "Sa" } }, - "S2n": { + "S2o": { "type": "structure", "required": [ "VendorName", @@ -2190,7 +2239,7 @@ "Name": {}, "Version": {}, "ExcludedRules": { - "shape": "S1k" + "shape": "S1l" }, "ScopeDownStatement": { "shape": "Sa" @@ -2209,12 +2258,12 @@ "deprecatedMessage": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType" }, "UsernameField": { - "shape": "S2u", + "shape": "S2v", "deprecated": true, "deprecatedMessage": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField" }, "PasswordField": { - "shape": "S2w", + "shape": "S2x", "deprecated": true, "deprecatedMessage": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField" }, @@ -2244,10 +2293,10 @@ "members": { "PayloadType": {}, "UsernameField": { - "shape": "S2u" + "shape": "S2v" }, "PasswordField": { - "shape": "S2w" + "shape": "S2x" } } }, @@ -2338,11 +2387,11 @@ } }, "RuleActionOverrides": { - "shape": "S1m" + "shape": "S1n" } } }, - "S2u": { + "S2v": { "type": "structure", "required": [ "Identifier" @@ -2351,7 +2400,7 @@ "Identifier": {} } }, - "S2w": { + "S2x": { "type": "structure", "required": [ "Identifier" @@ -2360,11 +2409,11 @@ "Identifier": {} } }, - "S3p": { + "S3q": { "type": "structure", "members": { "Count": { - "shape": "S1y" + "shape": "S1z" }, "None": { "type": "structure", @@ -2372,7 +2421,7 @@ } } }, - "S3r": { + "S3s": { "type": "list", "member": { "type": "structure", @@ -2384,7 +2433,7 @@ } } }, - "S3u": { + "S3v": { "type": "structure", "required": [ "SampledRequestsEnabled", @@ -2401,15 +2450,15 @@ "MetricName": {} } }, - "S3x": { + "S3y": { "type": "structure", "members": { "ImmunityTimeProperty": { - "shape": "S3y" + "shape": "S3z" } } }, - "S3y": { + "S3z": { "type": "structure", "required": [ "ImmunityTime" @@ -2420,19 +2469,19 @@ } } }, - "S40": { + "S41": { "type": "structure", "members": { "ImmunityTimeProperty": { - "shape": "S3y" + "shape": "S3z" } } }, - "S4b": { + "S4c": { "type": "list", "member": {} }, - "S4d": { + "S4e": { "type": "list", "member": { "type": "structure", @@ -2446,7 +2495,7 @@ } } }, - "S4i": { + "S4j": { "type": "structure", "members": { "Name": {}, @@ -2456,7 +2505,7 @@ "ARN": {} } }, - "S4m": { + "S4n": { "type": "list", "member": { "type": "structure", @@ -2465,7 +2514,7 @@ } } }, - "S4p": { + "S4q": { "type": "structure", "members": { "Name": {}, @@ -2475,7 +2524,7 @@ "ARN": {} } }, - "S4s": { + "S4t": { "type": "map", "key": {}, "value": { @@ -2490,7 +2539,7 @@ } } }, - "S4x": { + "S4y": { "type": "structure", "members": { "Name": {}, @@ -2500,22 +2549,22 @@ "ARN": {} } }, - "S4z": { + "S50": { "type": "structure", "members": { "Block": { - "shape": "S1p" + "shape": "S1q" }, "Allow": { - "shape": "S1w" + "shape": "S1x" } } }, - "S50": { + "S51": { "type": "list", "member": {} }, - "S51": { + "S52": { "type": "structure", "members": { "RequestBody": { @@ -2533,7 +2582,7 @@ } } }, - "S57": { + "S58": { "type": "structure", "members": { "Name": {}, @@ -2543,7 +2592,28 @@ "ARN": {} } }, - "S5q": { + "S5p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VendorName": {}, + "ManagedRuleSetName": {}, + "ProductId": {}, + "ProductLink": {}, + "ProductTitle": {}, + "ProductDescription": {}, + "SnsTopicArn": {}, + "IsVersioningSupported": { + "type": "boolean" + }, + "IsAdvancedManagedRuleSet": { + "type": "boolean" + } + } + } + }, + "S61": { "type": "list", "member": { "type": "structure", @@ -2552,7 +2622,7 @@ } } }, - "S66": { + "S6h": { "type": "structure", "required": [ "ResourceArn", @@ -2626,16 +2696,16 @@ } } }, - "S6y": { + "S79": { "type": "structure", "members": { "IPAddressVersion": {}, "Addresses": { - "shape": "S4b" + "shape": "S4c" } } }, - "S76": { + "S7h": { "type": "structure", "required": [ "StartTime", @@ -2650,7 +2720,7 @@ } } }, - "S7h": { + "S7s": { "type": "list", "member": { "type": "structure", @@ -2660,7 +2730,7 @@ } } }, - "S7v": { + "S86": { "type": "structure", "required": [ "Name", @@ -2674,46 +2744,46 @@ "Id": {}, "ARN": {}, "DefaultAction": { - "shape": "S4z" + "shape": "S50" }, "Description": {}, "Rules": { "shape": "S6" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" }, "Capacity": { "type": "long" }, "PreProcessFirewallManagerRuleGroups": { - "shape": "S7w" + "shape": "S87" }, "PostProcessFirewallManagerRuleGroups": { - "shape": "S7w" + "shape": "S87" }, "ManagedByFirewallManager": { "type": "boolean" }, "LabelNamespace": {}, "CustomResponseBodies": { - "shape": "S4s" + "shape": "S4t" }, "CaptchaConfig": { - "shape": "S3x" + "shape": "S3y" }, "ChallengeConfig": { - "shape": "S40" + "shape": "S41" }, "TokenDomains": { - "shape": "S50" + "shape": "S51" }, "AssociationConfig": { - "shape": "S51" + "shape": "S52" } } }, - "S7w": { + "S87": { "type": "list", "member": { "type": "structure", @@ -2733,18 +2803,18 @@ "type": "structure", "members": { "ManagedRuleGroupStatement": { - "shape": "S2n" + "shape": "S2o" }, "RuleGroupReferenceStatement": { - "shape": "S1j" + "shape": "S1k" } } }, "OverrideAction": { - "shape": "S3p" + "shape": "S3q" }, "VisibilityConfig": { - "shape": "S3u" + "shape": "S3v" } } } diff --git a/apis/wafv2-2019-07-29.normal.json b/apis/wafv2-2019-07-29.normal.json index fbc2561f08..f6294f36d4 100644 --- a/apis/wafv2-2019-07-29.normal.json +++ b/apis/wafv2-2019-07-29.normal.json @@ -549,6 +549,53 @@ ], "documentation": "Deletes the specified WebACL.
You can only use this if ManagedByFirewallManager
is false in the specified WebACL.
Before deleting any web ACL, first disassociate it from all resources.
To retrieve a list of the resources that are associated with a web ACL, use the following calls:
For regional resources, call ListResourcesForWebACL.
For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId
. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
To disassociate a resource from a web ACL, use the following calls:
For regional resources, call DisassociateWebACL.
For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution
. For information, see UpdateDistribution in the Amazon CloudFront API Reference.
Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
" + }, + "DescribeManagedProductsByVendor": { + "name": "DescribeManagedProductsByVendor", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeManagedProductsByVendorRequest" + }, + "output": { + "shape": "DescribeManagedProductsByVendorResponse" + }, + "errors": [ + { + "shape": "WAFInvalidOperationException" + }, + { + "shape": "WAFInternalErrorException" + }, + { + "shape": "WAFInvalidParameterException" + } + ], + "documentation": "Provides high-level information for the managed rule groups owned by a specific vendor.
" + }, "DescribeManagedRuleGroup": { "name": "DescribeManagedRuleGroup", "http": { @@ -1777,12 +1824,12 @@ "All": { "type": "structure", "members": {}, - "documentation": "Inspect all of the elements that WAF has parsed and extracted from the web request component that you've identified in your FieldToMatch specifications.
This is used only in the FieldToMatch specification for some web request component types.
JSON specification: \"All\": {}
Inspect all of the elements that WAF has parsed and extracted from the web request component that you've identified in your FieldToMatch specifications.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"All\": {}
Inspect all query arguments of the web request.
This is used only in the FieldToMatch specification for some web request component types.
JSON specification: \"AllQueryArguments\": {}
Inspect all query arguments of the web request.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"AllQueryArguments\": {}
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.
The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the body normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.
The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
Inspect the body of the web request. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
" @@ -1886,7 +1933,7 @@ "members": { "SearchString": { "shape": "SearchString", - "documentation": "A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch
:
Method
: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.
UriPath
: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg
.
If SearchString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of Type
is HEADER
and the value of Data
is User-Agent
. If you want to search the User-Agent
header for the value BadBot
, you base64-encode BadBot
using MIME base64-encoding and include the resulting value, QmFkQm90
, in the value of SearchString
.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
" + "documentation": "A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch
:
Method
: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.
UriPath
: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg
.
HeaderOrder
: The comma-separated list of header names to match for. WAF creates a string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of Type
is HEADER
and the value of Data
is User-Agent
. If you want to search the User-Agent
header for the value BadBot
, you base64-encode BadBot
using MIME base64-encoding and include the resulting value, QmFkQm90
, in the value of SearchString
.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
" }, "FieldToMatch": { "shape": "FieldToMatch", @@ -2089,7 +2136,7 @@ }, "OversizeHandling": { "shape": "OversizeHandling", - "documentation": "What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\", \"OversizeHandling\": \"MATCH\" }
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
" + } + } + }, + "DescribeManagedProductsByVendorRequest": { + "type": "structure", + "required": [ + "VendorName", + "Scope" + ], + "members": { + "VendorName": { + "shape": "VendorName", + "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "Scope": { + "shape": "Scope", + "documentation": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1
.
API and SDKs - For all calls, use the Region endpoint us-east-1.
High-level information for the managed rule groups owned by the specified vendor.
" + } + } + }, "DescribeManagedRuleGroupRequest": { "type": "structure", "required": [ @@ -2903,7 +2997,7 @@ "members": { "VendorName": { "shape": "VendorName", - "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
" + "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" }, "Name": { "shape": "EntityName", @@ -2928,7 +3022,7 @@ }, "SnsTopicArn": { "shape": "ResourceArn", - "documentation": "The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
" + "documentation": "The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
" }, "Capacity": { "shape": "CapacityUnit", @@ -3084,6 +3178,10 @@ "Cookies": { "shape": "Cookies", "documentation": "Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies
object, to define the set of cookies and the parts of the cookies that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies
object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using commas and no added spaces.
Matches against the header order string are case insensitive.
" } }, "documentation": "The part of the web request that you want WAF to inspect. Include the single FieldToMatch
type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch
for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.
Example JSON for a QueryString
field to match:
\"FieldToMatch\": { \"QueryString\": {} }
Example JSON for a Method
field to match specification:
\"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using commas and no added spaces.
Matches against the header order string are case insensitive.
" + }, "HeaderValue": { "type": "string" }, @@ -3759,7 +3870,7 @@ }, "OversizeHandling": { "shape": "OversizeHandling", - "documentation": "What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the headers normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
If you want to inspect just the value of a single header, use the SingleHeader
FieldToMatch
setting instead.
Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\", \"OversizeHandling\": \"MATCH\" }
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.
The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the body normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.
The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
Inspect the body of the web request as JSON. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
" + "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" }, "Name": { "shape": "EntityName", @@ -4552,6 +4663,54 @@ "min": 1, "pattern": ".*\\S.*" }, + "ManagedProductDescriptor": { + "type": "structure", + "members": { + "VendorName": { + "shape": "VendorName", + "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" + }, + "ManagedRuleSetName": { + "shape": "EntityName", + "documentation": "The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList
or AWSManagedRulesATPRuleSet
.
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
" + }, + "ProductLink": { + "shape": "ProductLink", + "documentation": "For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.
" + }, + "ProductTitle": { + "shape": "ProductTitle", + "documentation": "The display name for the managed rule group. For example, Anonymous IP list
or Account takeover prevention
.
A short description of the managed rule group.
" + }, + "SnsTopicArn": { + "shape": "ResourceArn", + "documentation": "The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
" + }, + "IsVersioningSupported": { + "shape": "Boolean", + "documentation": "Indicates whether the rule group is versioned.
" + }, + "IsAdvancedManagedRuleSet": { + "shape": "Boolean", + "documentation": "Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.
" + } + }, + "documentation": "The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.
" + }, + "ManagedProductDescriptors": { + "type": "list", + "member": { + "shape": "ManagedProductDescriptor" + } + }, "ManagedRuleGroupConfig": { "type": "structure", "members": { @@ -4605,7 +4764,7 @@ "members": { "VendorName": { "shape": "VendorName", - "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
" + "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" }, "Name": { "shape": "EntityName", @@ -4645,7 +4804,7 @@ "members": { "VendorName": { "shape": "VendorName", - "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
" + "documentation": "The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
" }, "Name": { "shape": "EntityName", @@ -4660,7 +4819,7 @@ "documentation": "The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
" } }, - "documentation": "High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Amazon Web Services Marketplace managed rule groups, which you can subscribe to through Amazon Web Services Marketplace.
" + "documentation": "High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.
" }, "ManagedRuleGroupVersion": { "type": "structure", @@ -4798,7 +4957,7 @@ "Method": { "type": "structure", "members": {}, - "documentation": "Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.
This is used only in the FieldToMatch specification for some web request component types.
JSON specification: \"Method\": {}
Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"Method\": {}
Inspect the query string of the web request. This is the part of a URL that appears after a ?
character, if any.
This is used only in the FieldToMatch specification for some web request component types.
JSON specification: \"QueryString\": {}
Inspect the query string of the web request. This is the part of a URL that appears after a ?
character, if any.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"QueryString\": {}
Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg
.
This is used only in the FieldToMatch specification for some web request component types.
JSON specification: \"UriPath\": {}
Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg
.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: \"UriPath\": {}
A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
" + "documentation": "Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
" }, "CloudWatchMetricsEnabled": { "shape": "Boolean", - "documentation": "A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
" + "documentation": "Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
" }, "MetricName": { "shape": "MetricName", diff --git a/apis/workspaces-web-2020-07-08.min.json b/apis/workspaces-web-2020-07-08.min.json index 4a456902d9..438181e545 100644 --- a/apis/workspaces-web-2020-07-08.min.json +++ b/apis/workspaces-web-2020-07-08.min.json @@ -48,6 +48,42 @@ }, "idempotent": true }, + "AssociateIpAccessSettings": { + "http": { + "method": "PUT", + "requestUri": "/portals/{portalArn+}/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ipAccessSettingsArn", + "portalArn" + ], + "members": { + "ipAccessSettingsArn": { + "location": "querystring", + "locationName": "ipAccessSettingsArn" + }, + "portalArn": { + "location": "uri", + "locationName": "portalArn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ipAccessSettingsArn", + "portalArn" + ], + "members": { + "ipAccessSettingsArn": {}, + "portalArn": {} + } + }, + "idempotent": true + }, "AssociateNetworkSettings": { "http": { "method": "PUT", @@ -204,17 +240,17 @@ ], "members": { "additionalEncryptionContext": { - "shape": "Sd" + "shape": "Sf" }, "browserPolicy": { - "shape": "Sf" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true }, "customerManagedKey": {}, "tags": { - "shape": "Si" + "shape": "Sk" } } }, @@ -246,10 +282,10 @@ "idempotencyToken": true }, "identityProviderDetails": { - "shape": "So" + "shape": "Sq" }, "identityProviderName": { - "shape": "Sp" + "shape": "Sr" }, "identityProviderType": {}, "portalArn": {} @@ -265,6 +301,48 @@ } } }, + "CreateIpAccessSettings": { + "http": { + "requestUri": "/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ipRules" + ], + "members": { + "additionalEncryptionContext": { + "shape": "Sf" + }, + "clientToken": { + "idempotencyToken": true + }, + "customerManagedKey": {}, + "description": { + "shape": "Sv" + }, + "displayName": { + "shape": "Sw" + }, + "ipRules": { + "shape": "Sx" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "ipAccessSettingsArn": {} + } + } + }, "CreateNetworkSettings": { "http": { "requestUri": "/networkSettings", @@ -282,13 +360,13 @@ "idempotencyToken": true }, "securityGroupIds": { - "shape": "St" + "shape": "S12" }, "subnetIds": { - "shape": "Sv" + "shape": "S14" }, "tags": { - "shape": "Si" + "shape": "Sk" }, "vpcId": {} } @@ -312,7 +390,7 @@ "type": "structure", "members": { "additionalEncryptionContext": { - "shape": "Sd" + "shape": "Sf" }, "authenticationType": {}, "clientToken": { @@ -320,10 +398,10 @@ }, "customerManagedKey": {}, "displayName": { - "shape": "S11" + "shape": "Sw" }, "tags": { - "shape": "Si" + "shape": "Sk" } } }, @@ -351,13 +429,13 @@ ], "members": { "certificateList": { - "shape": "S15" + "shape": "S1d" }, "clientToken": { "idempotencyToken": true }, "tags": { - "shape": "Si" + "shape": "Sk" } } }, @@ -387,7 +465,7 @@ }, "kinesisStreamArn": {}, "tags": { - "shape": "Si" + "shape": "Sk" } } }, @@ -430,7 +508,7 @@ "pasteAllowed": {}, "printAllowed": {}, "tags": { - "shape": "Si" + "shape": "Sk" }, "uploadAllowed": {} } @@ -493,6 +571,30 @@ }, "idempotent": true }, + "DeleteIpAccessSettings": { + "http": { + "method": "DELETE", + "requestUri": "/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "ipAccessSettingsArn": { + "location": "uri", + "locationName": "ipAccessSettingsArn" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, "DeleteNetworkSettings": { "http": { "method": "DELETE", @@ -637,6 +739,30 @@ }, "idempotent": true }, + "DisassociateIpAccessSettings": { + "http": { + "method": "DELETE", + "requestUri": "/portals/{portalArn+}/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "portalArn" + ], + "members": { + "portalArn": { + "location": "uri", + "locationName": "portalArn" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, "DisassociateNetworkSettings": { "http": { "method": "DELETE", @@ -755,7 +881,7 @@ "type": "structure", "members": { "browserSettings": { - "shape": "S26" + "shape": "S2i" } } } @@ -782,7 +908,34 @@ "type": "structure", "members": { "identityProvider": { - "shape": "S2a" + "shape": "S2m" + } + } + } + }, + "GetIpAccessSettings": { + "http": { + "method": "GET", + "requestUri": "/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "ipAccessSettingsArn": { + "location": "uri", + "locationName": "ipAccessSettingsArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "ipAccessSettings": { + "shape": "S2p" } } } @@ -809,7 +962,7 @@ "type": "structure", "members": { "networkSettings": { - "shape": "S2d" + "shape": "S2t" } } } @@ -836,7 +989,7 @@ "type": "structure", "members": { "portal": { - "shape": "S2g" + "shape": "S2w" } } } @@ -895,7 +1048,7 @@ "type": "structure", "members": { "associatedPortalArns": { - "shape": "S27" + "shape": "S2j" }, "trustStoreArn": {} } @@ -972,7 +1125,7 @@ "type": "structure", "members": { "userAccessLoggingSettings": { - "shape": "S2z" + "shape": "S3e" } } } @@ -999,7 +1152,7 @@ "type": "structure", "members": { "userSettings": { - "shape": "S32" + "shape": "S3h" } } } @@ -1077,7 +1230,7 @@ "members": { "identityProviderArn": {}, "identityProviderName": { - "shape": "Sp" + "shape": "Sr" }, "identityProviderType": {} } @@ -1087,6 +1240,51 @@ } } }, + "ListIpAccessSettings": { + "http": { + "method": "GET", + "requestUri": "/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "ipAccessSettings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "creationDate": { + "type": "timestamp" + }, + "description": { + "shape": "Sv" + }, + "displayName": { + "shape": "Sw" + }, + "ipAccessSettingsArn": {} + } + } + }, + "nextToken": {} + } + } + }, "ListNetworkSettings": { "http": { "method": "GET", @@ -1160,8 +1358,9 @@ "type": "timestamp" }, "displayName": { - "shape": "S11" + "shape": "Sw" }, + "ipAccessSettingsArn": {}, "networkSettingsArn": {}, "portalArn": {}, "portalEndpoint": {}, @@ -1198,7 +1397,7 @@ "type": "structure", "members": { "tags": { - "shape": "Si" + "shape": "Sk" } } } @@ -1395,7 +1594,7 @@ "locationName": "resourceArn" }, "tags": { - "shape": "Si" + "shape": "Sk" } } }, @@ -1426,7 +1625,7 @@ "locationName": "tagKeys", "type": "list", "member": { - "shape": "Sk" + "shape": "Sm" } } } @@ -1450,7 +1649,7 @@ ], "members": { "browserPolicy": { - "shape": "Sf" + "shape": "Sh" }, "browserSettingsArn": { "location": "uri", @@ -1468,7 +1667,7 @@ ], "members": { "browserSettings": { - "shape": "S26" + "shape": "S2i" } } } @@ -1493,10 +1692,10 @@ "locationName": "identityProviderArn" }, "identityProviderDetails": { - "shape": "So" + "shape": "Sq" }, "identityProviderName": { - "shape": "Sp" + "shape": "Sr" }, "identityProviderType": {} } @@ -1508,7 +1707,49 @@ ], "members": { "identityProvider": { - "shape": "S2a" + "shape": "S2m" + } + } + } + }, + "UpdateIpAccessSettings": { + "http": { + "method": "PATCH", + "requestUri": "/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "description": { + "shape": "Sv" + }, + "displayName": { + "shape": "Sw" + }, + "ipAccessSettingsArn": { + "location": "uri", + "locationName": "ipAccessSettingsArn" + }, + "ipRules": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ipAccessSettings" + ], + "members": { + "ipAccessSettings": { + "shape": "S2p" } } } @@ -1533,10 +1774,10 @@ "locationName": "networkSettingsArn" }, "securityGroupIds": { - "shape": "St" + "shape": "S12" }, "subnetIds": { - "shape": "Sv" + "shape": "S14" }, "vpcId": {} } @@ -1548,7 +1789,7 @@ ], "members": { "networkSettings": { - "shape": "S2d" + "shape": "S2t" } } } @@ -1567,7 +1808,7 @@ "members": { "authenticationType": {}, "displayName": { - "shape": "S11" + "shape": "Sw" }, "portalArn": { "location": "uri", @@ -1579,7 +1820,7 @@ "type": "structure", "members": { "portal": { - "shape": "S2g" + "shape": "S2w" } } }, @@ -1598,7 +1839,7 @@ ], "members": { "certificatesToAdd": { - "shape": "S15" + "shape": "S1d" }, "certificatesToDelete": { "type": "list", @@ -1652,7 +1893,7 @@ ], "members": { "userAccessLoggingSettings": { - "shape": "S2z" + "shape": "S3e" } } } @@ -1696,23 +1937,23 @@ ], "members": { "userSettings": { - "shape": "S32" + "shape": "S3h" } } } } }, "shapes": { - "Sd": { + "Sf": { "type": "map", "key": {}, "value": {} }, - "Sf": { + "Sh": { "type": "string", "sensitive": true }, - "Si": { + "Sk": { "type": "list", "member": { "type": "structure", @@ -1722,7 +1963,7 @@ ], "members": { "Key": { - "shape": "Sk" + "shape": "Sm" }, "Value": { "type": "string", @@ -1732,58 +1973,81 @@ "sensitive": true } }, - "Sk": { + "Sm": { "type": "string", "sensitive": true }, - "So": { + "Sq": { "type": "map", "key": {}, "value": {}, "sensitive": true }, - "Sp": { + "Sr": { + "type": "string", + "sensitive": true + }, + "Sv": { + "type": "string", + "sensitive": true + }, + "Sw": { "type": "string", "sensitive": true }, - "St": { + "Sx": { "type": "list", - "member": {} + "member": { + "type": "structure", + "required": [ + "ipRange" + ], + "members": { + "description": { + "shape": "Sv" + }, + "ipRange": { + "type": "string", + "sensitive": true + } + } + }, + "sensitive": true }, - "Sv": { + "S12": { "type": "list", "member": {} }, - "S11": { - "type": "string", - "sensitive": true + "S14": { + "type": "list", + "member": {} }, - "S15": { + "S1d": { "type": "list", "member": { "type": "blob" } }, - "S26": { + "S2i": { "type": "structure", "required": [ "browserSettingsArn" ], "members": { "associatedPortalArns": { - "shape": "S27" + "shape": "S2j" }, "browserPolicy": { - "shape": "Sf" + "shape": "Sh" }, "browserSettingsArn": {} } }, - "S27": { + "S2j": { "type": "list", "member": {} }, - "S2a": { + "S2m": { "type": "structure", "required": [ "identityProviderArn" @@ -1791,34 +2055,58 @@ "members": { "identityProviderArn": {}, "identityProviderDetails": { - "shape": "So" + "shape": "Sq" }, "identityProviderName": { - "shape": "Sp" + "shape": "Sr" }, "identityProviderType": {} } }, - "S2d": { + "S2p": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "associatedPortalArns": { + "shape": "S2j" + }, + "creationDate": { + "type": "timestamp" + }, + "description": { + "shape": "Sv" + }, + "displayName": { + "shape": "Sw" + }, + "ipAccessSettingsArn": {}, + "ipRules": { + "shape": "Sx" + } + } + }, + "S2t": { "type": "structure", "required": [ "networkSettingsArn" ], "members": { "associatedPortalArns": { - "shape": "S27" + "shape": "S2j" }, "networkSettingsArn": {}, "securityGroupIds": { - "shape": "St" + "shape": "S12" }, "subnetIds": { - "shape": "Sv" + "shape": "S14" }, "vpcId": {} } }, - "S2g": { + "S2w": { "type": "structure", "members": { "authenticationType": {}, @@ -1828,8 +2116,9 @@ "type": "timestamp" }, "displayName": { - "shape": "S11" + "shape": "Sw" }, + "ipAccessSettingsArn": {}, "networkSettingsArn": {}, "portalArn": {}, "portalEndpoint": {}, @@ -1841,27 +2130,27 @@ "userSettingsArn": {} } }, - "S2z": { + "S3e": { "type": "structure", "required": [ "userAccessLoggingSettingsArn" ], "members": { "associatedPortalArns": { - "shape": "S27" + "shape": "S2j" }, "kinesisStreamArn": {}, "userAccessLoggingSettingsArn": {} } }, - "S32": { + "S3h": { "type": "structure", "required": [ "userSettingsArn" ], "members": { "associatedPortalArns": { - "shape": "S27" + "shape": "S2j" }, "copyAllowed": {}, "disconnectTimeoutInMinutes": { diff --git a/apis/workspaces-web-2020-07-08.normal.json b/apis/workspaces-web-2020-07-08.normal.json index f07eddbce0..50a3070208 100644 --- a/apis/workspaces-web-2020-07-08.normal.json +++ b/apis/workspaces-web-2020-07-08.normal.json @@ -48,6 +48,42 @@ "documentation": "Associates a browser settings resource with a web portal.
", "idempotent": true }, + "AssociateIpAccessSettings": { + "name": "AssociateIpAccessSettings", + "http": { + "method": "PUT", + "requestUri": "/portals/{portalArn+}/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "shape": "AssociateIpAccessSettingsRequest" + }, + "output": { + "shape": "AssociateIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Associates an IP access settings resource with a web portal.
", + "idempotent": true + }, "AssociateNetworkSettings": { "name": "AssociateNetworkSettings", "http": { @@ -265,6 +301,41 @@ ], "documentation": "Creates an identity provider resource that is then associated with a web portal.
" }, + "CreateIpAccessSettings": { + "name": "CreateIpAccessSettings", + "http": { + "method": "POST", + "requestUri": "/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "shape": "CreateIpAccessSettingsRequest" + }, + "output": { + "shape": "CreateIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Creates an IP access settings resource that can be associated with a web portal.
" + }, "CreateNetworkSettings": { "name": "CreateNetworkSettings", "http": { @@ -509,6 +580,39 @@ "documentation": "Deletes the identity provider.
", "idempotent": true }, + "DeleteIpAccessSettings": { + "name": "DeleteIpAccessSettings", + "http": { + "method": "DELETE", + "requestUri": "/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteIpAccessSettingsRequest" + }, + "output": { + "shape": "DeleteIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Deletes IP access settings.
", + "idempotent": true + }, "DeleteNetworkSettings": { "name": "DeleteNetworkSettings", "http": { @@ -707,6 +811,39 @@ "documentation": "Disassociates browser settings from a web portal.
", "idempotent": true }, + "DisassociateIpAccessSettings": { + "name": "DisassociateIpAccessSettings", + "http": { + "method": "DELETE", + "requestUri": "/portals/{portalArn+}/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "shape": "DisassociateIpAccessSettingsRequest" + }, + "output": { + "shape": "DisassociateIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Disassociates IP access settings from a web portal.
", + "idempotent": true + }, "DisassociateNetworkSettings": { "name": "DisassociateNetworkSettings", "http": { @@ -903,6 +1040,38 @@ ], "documentation": "Gets the identity provider.
" }, + "GetIpAccessSettings": { + "name": "GetIpAccessSettings", + "http": { + "method": "GET", + "requestUri": "/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode": 200 + }, + "input": { + "shape": "GetIpAccessSettingsRequest" + }, + "output": { + "shape": "GetIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Gets the IP access settings.
" + }, "GetNetworkSettings": { "name": "GetNetworkSettings", "http": { @@ -1185,6 +1354,35 @@ ], "documentation": "Retrieves a list of identity providers for a specific web portal.
" }, + "ListIpAccessSettings": { + "name": "ListIpAccessSettings", + "http": { + "method": "GET", + "requestUri": "/ipAccessSettings", + "responseCode": 200 + }, + "input": { + "shape": "ListIpAccessSettingsRequest" + }, + "output": { + "shape": "ListIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves a list of IP access settings.
" + }, "ListNetworkSettings": { "name": "ListNetworkSettings", "http": { @@ -1526,6 +1724,38 @@ ], "documentation": "Updates the identity provider.
" }, + "UpdateIpAccessSettings": { + "name": "UpdateIpAccessSettings", + "http": { + "method": "PATCH", + "requestUri": "/ipAccessSettings/{ipAccessSettingsArn+}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateIpAccessSettingsRequest" + }, + "output": { + "shape": "UpdateIpAccessSettingsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Updates IP access settings.
" + }, "UpdateNetworkSettings": { "name": "UpdateNetworkSettings", "http": { @@ -1586,6 +1816,9 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], "documentation": "Updates a web portal.
", @@ -1742,6 +1975,44 @@ } } }, + "AssociateIpAccessSettingsRequest": { + "type": "structure", + "required": [ + "ipAccessSettingsArn", + "portalArn" + ], + "members": { + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings.
", + "location": "querystring", + "locationName": "ipAccessSettingsArn" + }, + "portalArn": { + "shape": "ARN", + "documentation": "The ARN of the web portal.
", + "location": "uri", + "locationName": "portalArn" + } + } + }, + "AssociateIpAccessSettingsResponse": { + "type": "structure", + "required": [ + "ipAccessSettingsArn", + "portalArn" + ], + "members": { + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings resource.
" + }, + "portalArn": { + "shape": "ARN", + "documentation": "The ARN of the web portal.
" + } + } + }, "AssociateNetworkSettingsRequest": { "type": "structure", "required": [ @@ -2130,6 +2401,55 @@ } } }, + "CreateIpAccessSettingsRequest": { + "type": "structure", + "required": [ + "ipRules" + ], + "members": { + "additionalEncryptionContext": { + "shape": "EncryptionContextMap", + "documentation": "Additional encryption context of the IP access settings.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
", + "idempotencyToken": true + }, + "customerManagedKey": { + "shape": "keyArn", + "documentation": "The custom managed key of the IP access settings.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the IP access settings.
" + }, + "displayName": { + "shape": "DisplayName", + "documentation": "The display name of the IP access settings.
" + }, + "ipRules": { + "shape": "IpRuleList", + "documentation": "The IP rules of the IP access settings.
" + }, + "tags": { + "shape": "TagList", + "documentation": "The tags to add to the browser settings resource. A tag is a key-value pair.
" + } + } + }, + "CreateIpAccessSettingsResponse": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings resource.
" + } + } + }, "CreateNetworkSettingsRequest": { "type": "structure", "required": [ @@ -2383,6 +2703,24 @@ "type": "structure", "members": {} }, + "DeleteIpAccessSettingsRequest": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings.
", + "location": "uri", + "locationName": "ipAccessSettingsArn" + } + } + }, + "DeleteIpAccessSettingsResponse": { + "type": "structure", + "members": {} + }, "DeleteNetworkSettingsRequest": { "type": "structure", "required": [ @@ -2473,6 +2811,13 @@ "type": "structure", "members": {} }, + "Description": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "^.+$", + "sensitive": true + }, "DisassociateBrowserSettingsRequest": { "type": "structure", "required": [ @@ -2491,6 +2836,24 @@ "type": "structure", "members": {} }, + "DisassociateIpAccessSettingsRequest": { + "type": "structure", + "required": [ + "portalArn" + ], + "members": { + "portalArn": { + "shape": "ARN", + "documentation": "The ARN of the web portal.
", + "location": "uri", + "locationName": "portalArn" + } + } + }, + "DisassociateIpAccessSettingsResponse": { + "type": "structure", + "members": {} + }, "DisassociateNetworkSettingsRequest": { "type": "structure", "required": [ @@ -2638,6 +3001,29 @@ } } }, + "GetIpAccessSettingsRequest": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings.
", + "location": "uri", + "locationName": "ipAccessSettingsArn" + } + } + }, + "GetIpAccessSettingsResponse": { + "type": "structure", + "members": { + "ipAccessSettings": { + "shape": "IpAccessSettings", + "documentation": "The IP access settings.
" + } + } + }, "GetNetworkSettingsRequest": { "type": "structure", "required": [ @@ -2900,6 +3286,99 @@ "max": 60, "min": 0 }, + "IpAccessSettings": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "associatedPortalArns": { + "shape": "ArnList", + "documentation": "A list of web portal ARNs that this IP access settings resource is associated with.
" + }, + "creationDate": { + "shape": "Timestamp", + "documentation": "The creation date timestamp of the IP access settings.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the IP access settings.
" + }, + "displayName": { + "shape": "DisplayName", + "documentation": "The display name of the IP access settings.
" + }, + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings resource.
" + }, + "ipRules": { + "shape": "IpRuleList", + "documentation": "The IP rules of the IP access settings.
" + } + }, + "documentation": "The IP access settings resource that can be associated with a web portal.
" + }, + "IpAccessSettingsList": { + "type": "list", + "member": { + "shape": "IpAccessSettingsSummary" + } + }, + "IpAccessSettingsSummary": { + "type": "structure", + "members": { + "creationDate": { + "shape": "Timestamp", + "documentation": "The creation date timestamp of the IP access settings.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the IP access settings.
" + }, + "displayName": { + "shape": "DisplayName", + "documentation": "The display name of the IP access settings.
" + }, + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of IP access settings.
" + } + }, + "documentation": "The summary of IP access settings.
" + }, + "IpRange": { + "type": "string", + "documentation": "A single IP address or an IP address range in CIDR notation
", + "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(?:/([0-9]|[12][0-9]|3[0-2])|)$", + "sensitive": true + }, + "IpRule": { + "type": "structure", + "required": [ + "ipRange" + ], + "members": { + "description": { + "shape": "Description", + "documentation": "The description of the IP rule.
" + }, + "ipRange": { + "shape": "IpRange", + "documentation": "The IP range of the IP rule.
" + } + }, + "documentation": "The IP rules of the IP access settings.
" + }, + "IpRuleList": { + "type": "list", + "member": { + "shape": "IpRule" + }, + "max": 100, + "min": 1, + "sensitive": true + }, "KinesisStreamArn": { "type": "string", "documentation": "Kinesis stream ARN to which log events are published.
", @@ -2976,6 +3455,36 @@ } } }, + "ListIpAccessSettingsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to be included in the next page.
", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "ListIpAccessSettingsResponse": { + "type": "structure", + "members": { + "ipAccessSettings": { + "shape": "IpAccessSettingsList", + "documentation": "The IP access settings.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + }, "ListNetworkSettingsRequest": { "type": "structure", "members": { @@ -3275,6 +3784,10 @@ "shape": "DisplayName", "documentation": "The name of the web portal.
" }, + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings.
" + }, "networkSettingsArn": { "shape": "ARN", "documentation": "The ARN of the network settings that is associated with the web portal.
" @@ -3357,6 +3870,10 @@ "shape": "DisplayName", "documentation": "The name of the web portal.
" }, + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings.
" + }, "networkSettingsArn": { "shape": "ARN", "documentation": "The ARN of the network settings that is associated with the web portal.
" @@ -3657,6 +4174,49 @@ } } }, + "UpdateIpAccessSettingsRequest": { + "type": "structure", + "required": [ + "ipAccessSettingsArn" + ], + "members": { + "clientToken": { + "shape": "ClientToken", + "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
", + "idempotencyToken": true + }, + "description": { + "shape": "Description", + "documentation": "The description of the IP access settings.
" + }, + "displayName": { + "shape": "DisplayName", + "documentation": "The display name of the IP access settings.
" + }, + "ipAccessSettingsArn": { + "shape": "ARN", + "documentation": "The ARN of the IP access settings.
", + "location": "uri", + "locationName": "ipAccessSettingsArn" + }, + "ipRules": { + "shape": "IpRuleList", + "documentation": "The updated IP rules of the IP access settings.
" + } + } + }, + "UpdateIpAccessSettingsResponse": { + "type": "structure", + "required": [ + "ipAccessSettings" + ], + "members": { + "ipAccessSettings": { + "shape": "IpAccessSettings", + "documentation": "The IP access settings.
" + } + } + }, "UpdateNetworkSettingsRequest": { "type": "structure", "required": [ diff --git a/apis/workspaces-web-2020-07-08.paginators.json b/apis/workspaces-web-2020-07-08.paginators.json index 202a631681..98a3786503 100644 --- a/apis/workspaces-web-2020-07-08.paginators.json +++ b/apis/workspaces-web-2020-07-08.paginators.json @@ -10,6 +10,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListIpAccessSettings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListNetworkSettings": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/clients/alexaforbusiness.d.ts b/clients/alexaforbusiness.d.ts index 3cf79b9f2a..7056008e0b 100644 --- a/clients/alexaforbusiness.d.ts +++ b/clients/alexaforbusiness.d.ts @@ -1306,6 +1306,7 @@ declare namespace AlexaForBusiness { * Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.” */ RequireCheckIn?: CreateRequireCheckIn; + ProactiveJoin?: CreateProactiveJoin; } export interface CreateNetworkProfileRequest { /** @@ -1356,6 +1357,9 @@ declare namespace AlexaForBusiness { */ NetworkProfileArn?: Arn; } + export interface CreateProactiveJoin { + EnabledByMotion: Boolean; + } export interface CreateProfileRequest { /** * The name of a room profile. @@ -2458,6 +2462,7 @@ declare namespace AlexaForBusiness { * Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.” */ RequireCheckIn?: RequireCheckIn; + ProactiveJoin?: ProactiveJoin; } export interface MeetingSetting { /** @@ -2582,6 +2587,9 @@ declare namespace AlexaForBusiness { export type PhoneNumberList = PhoneNumber[]; export type PhoneNumberType = "MOBILE"|"WORK"|"HOME"|string; export type PrivacyPolicy = string; + export interface ProactiveJoin { + EnabledByMotion?: Boolean; + } export type ProductDescription = string; export type ProductId = string; export interface Profile { @@ -3652,6 +3660,7 @@ declare namespace AlexaForBusiness { * Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.” */ RequireCheckIn?: UpdateRequireCheckIn; + ProactiveJoin?: UpdateProactiveJoin; } export interface UpdateNetworkProfileRequest { /** @@ -3685,6 +3694,9 @@ declare namespace AlexaForBusiness { } export interface UpdateNetworkProfileResponse { } + export interface UpdateProactiveJoin { + EnabledByMotion: Boolean; + } export interface UpdateProfileRequest { /** * The ARN of the room profile to update. Required. diff --git a/clients/appflow.d.ts b/clients/appflow.d.ts index 899979651e..c0973956bc 100644 --- a/clients/appflow.d.ts +++ b/clients/appflow.d.ts @@ -459,6 +459,14 @@ declare namespace Appflow { * Information about who registered the connector. */ registeredBy?: RegisteredBy; + /** + * The data transfer types that the connector supports. RECORD Structured records. FILE Files or binary data. + */ + supportedDataTransferTypes?: SupportedDataTransferTypeList; + /** + * The APIs of the connector application that Amazon AppFlow can use to transfer your data. + */ + supportedDataTransferApis?: SupportedDataTransferApis; } export type ConnectorConfigurationsMap = {[key: string]: ConnectorConfiguration}; export type ConnectorDescription = string; @@ -507,6 +515,10 @@ declare namespace Appflow { * The connection mode that the connector supports. */ connectorModes?: ConnectorModeList; + /** + * The data transfer types that the connector supports. RECORD Structured records. FILE Files or binary data. + */ + supportedDataTransferTypes?: SupportedDataTransferTypeList; } export interface ConnectorEntity { /** @@ -1167,6 +1179,10 @@ declare namespace Appflow { * Custom properties that are required to use the custom connector as a source. */ customProperties?: CustomProperties; + /** + * The API of the connector application that Amazon AppFlow uses to transfer your data. + */ + dataTransferApi?: DataTransferApi; } export type CustomProperties = {[key: string]: CustomPropertyValue}; export type CustomPropertyKey = string; @@ -1185,6 +1201,18 @@ declare namespace Appflow { } export type DataApiRoleArn = string; export type DataPullMode = "Incremental"|"Complete"|string; + export interface DataTransferApi { + /** + * The name of the connector application API. + */ + Name?: DataTransferApiTypeName; + /** + * You can specify one of the following types: AUTOMATIC The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers. SYNC A synchronous API. This type of API optimizes a flow for small to medium-sized datasets. ASYNC An asynchronous API. This type of API optimizes a flow for large datasets. + */ + Type?: DataTransferApiType; + } + export type DataTransferApiType = "SYNC"|"ASYNC"|"AUTOMATIC"|string; + export type DataTransferApiTypeName = string; export type DatabaseName = string; export type DatabaseUrl = string; export type DatadogConnectorOperator = "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP"|string; @@ -2957,6 +2985,9 @@ declare namespace Appflow { } export type SupportedApiVersion = string; export type SupportedApiVersionList = SupportedApiVersion[]; + export type SupportedDataTransferApis = DataTransferApi[]; + export type SupportedDataTransferType = "RECORD"|"FILE"|string; + export type SupportedDataTransferTypeList = SupportedDataTransferType[]; export interface SupportedFieldTypeDetails { /** * The initial supported version for fieldType. If this is later changed to a different version, v2 will be introduced. diff --git a/clients/athena.d.ts b/clients/athena.d.ts index 6a0c099542..9c5a720285 100644 --- a/clients/athena.d.ts +++ b/clients/athena.d.ts @@ -36,11 +36,11 @@ declare class Athena extends Service { */ batchGetQueryExecution(callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request