The platform for the Amplify app.
", - "CreateAppRequest$platform": "The platform or framework for an Amplify app.
", - "UpdateAppRequest$platform": "The platform for an Amplify app.
" + "App$platform": " The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
" } }, + "CatalogType": { + "base": null, + "refs": { + "MetadataCatalogDetail$catalogType": "The type of metadata catalog that Amazon AppFlow used for the associated flow run. This parameter returns the following value:
The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.
Specifies the status of the most recent flow run.
", - "ExecutionRecord$executionStatus": "Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
" + "ExecutionRecord$executionStatus": "Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
", + "RegistrationOutput$status": "Indicates the status of the registration attempt from Amazon AppFlow.
" } }, "FieldType": { @@ -1194,6 +1201,30 @@ "DescribeFlowResponse$flowStatusMessage": "Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
" } }, + "GlueDataCatalogConfig": { + "base": "Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that's transferred by the flow that you configure with these settings.
You can configure a flow with these settings only when the flow destination is Amazon S3.
Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog.
" + } + }, + "GlueDataCatalogDatabaseName": { + "base": null, + "refs": { + "GlueDataCatalogConfig$databaseName": "The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.
When you configure a new flow with this parameter, you must specify an existing database.
The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.
For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
" + } + }, + "GlueDataCatalogTablePrefix": { + "base": null, + "refs": { + "GlueDataCatalogConfig$tablePrefix": "A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
" + } + }, "GoogleAnalyticsConnectorOperator": { "base": null, "refs": { @@ -1420,6 +1451,8 @@ "Long": { "base": null, "refs": { + "AggregationConfig$targetFileSize": "The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains.
", + "DescribeFlowResponse$schemaVersion": "The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
Specifies the failure count for the attempted flow.
", "ExecutionResult$bytesProcessed": "The total number of bytes processed by the flow run.
", "ExecutionResult$bytesWritten": "The total number of bytes written as a result of the flow run.
", @@ -1478,6 +1511,27 @@ "ListFlowsRequest$maxResults": "Specifies the maximum number of items that should be returned in the result set.
" } }, + "MetadataCatalogConfig": { + "base": "Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.
", + "refs": { + "CreateFlowRequest$metadataCatalogConfig": "Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
", + "DescribeFlowResponse$metadataCatalogConfig": "Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
", + "UpdateFlowRequest$metadataCatalogConfig": "Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
" + } + }, + "MetadataCatalogDetail": { + "base": "Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
", + "refs": { + "MetadataCatalogDetails$member": null + } + }, + "MetadataCatalogDetails": { + "base": null, + "refs": { + "DescribeFlowResponse$lastRunMetadataCatalogDetails": "Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
", + "ExecutionRecord$metadataCatalogDetails": "Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
" + } + }, "MostRecentExecutionMessage": { "base": null, "refs": { @@ -1647,6 +1701,18 @@ "VeevaConnectorProfileCredentials$password": "The password that corresponds to the user name.
" } }, + "PathPrefix": { + "base": null, + "refs": { + "PathPrefixHierarchy$member": null + } + }, + "PathPrefixHierarchy": { + "base": null, + "refs": { + "PrefixConfig$pathPrefixHierarchy": "Specifies whether the destination file path includes either or both of the following elements:
The ID that Amazon AppFlow assigns to the flow run.
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date.
", + "base": "Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.
", "refs": { "S3OutputFormatConfig$prefixConfig": "Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.
", "UpsolverS3OutputFormatConfig$prefixConfig": null @@ -1663,13 +1729,13 @@ "PrefixFormat": { "base": null, "refs": { - "PrefixConfig$prefixFormat": "Determines the level of granularity that's included in the prefix.
" + "PrefixConfig$prefixFormat": "Determines the level of granularity for the date and time that's included in the prefix.
" } }, "PrefixType": { "base": null, "refs": { - "PrefixConfig$prefixType": "Determines the format of the prefix, and whether it applies to the file name, file path, or both.
" + "PrefixConfig$prefixType": "Determines the format of the prefix, and whether it applies to the file name, file path, or both.
" } }, "PrivateConnectionProvisioningFailureCause": { @@ -1804,6 +1870,13 @@ "ConnectorDetail$registeredBy": "The user who registered the connector.
" } }, + "RegistrationOutput": { + "base": "Describes the status of an attempt from Amazon AppFlow to register a resource.
When you run a flow that you've configured to use a metadata catalog, Amazon AppFlow registers a metadata table and data partitions with that catalog. This operation provides the status of that registration attempt. The operation also indicates how many related resources Amazon AppFlow created or updated.
", + "refs": { + "MetadataCatalogDetail$tableRegistrationOutput": "Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog. Amazon AppFlow creates or updates this table for the associated flow run.
", + "MetadataCatalogDetail$partitionRegistrationOutput": "Describes the status of the attempt from Amazon AppFlow to register the data partitions with the metadata catalog. The data partitions organize the flow output into a hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the partitions (if they don't already exist) based on your flow configuration.
" + } + }, "ResourceNotFoundException": { "base": "The resource specified in the request (such as the source or destination connector profile) is not found.
", "refs": { @@ -2156,6 +2229,9 @@ "ConnectorEntityField$defaultValue": "Default value that can be assigned to this field.
", "FieldTypeDetails$valueRegexPattern": "The regular expression pattern for the field name.
", "FieldTypeDetails$supportedDateFormat": "The date format that the field supports.
", + "MetadataCatalogDetail$tableName": "The name of the table that stores the metadata for the associated flow run. The table stores metadata that represents the data that the flow transferred. Amazon AppFlow stores the table in the metadata catalog.
", + "RegistrationOutput$message": "Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why.
", + "RegistrationOutput$result": "Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions.
", "SourceFields$member": null } }, diff --git a/models/apis/appflow/2020-08-23/endpoint-rule-set-1.json b/models/apis/appflow/2020-08-23/endpoint-rule-set-1.json new file mode 100644 index 00000000000..d90efce974c --- /dev/null +++ b/models/apis/appflow/2020-08-23/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appflow-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appflow-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appflow.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://appflow.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/appflow/2020-08-23/endpoint-tests-1.json b/models/apis/appflow/2020-08-23/endpoint-tests-1.json new file mode 100644 index 00000000000..45e1b7d9c2e --- /dev/null +++ b/models/apis/appflow/2020-08-23/endpoint-tests-1.json @@ -0,0 +1,875 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appflow.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/appsync/2017-07-25/api-2.json b/models/apis/appsync/2017-07-25/api-2.json index 24b7726b46e..a75d9d9ac25 100644 --- a/models/apis/appsync/2017-07-25/api-2.json +++ b/models/apis/appsync/2017-07-25/api-2.json @@ -137,7 +137,8 @@ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, - {"shape":"InternalFailureException"} + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} ] }, "CreateType":{ @@ -263,7 +264,8 @@ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, - {"shape":"InternalFailureException"} + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} ] }, "DeleteType":{ @@ -298,6 +300,20 @@ {"shape":"NotFoundException"} ] }, + "EvaluateCode":{ + "name":"EvaluateCode", + "http":{ + "method":"POST", + "requestUri":"/v1/dataplane-evaluatecode" + }, + "input":{"shape":"EvaluateCodeRequest"}, + "output":{"shape":"EvaluateCodeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ] + }, "EvaluateMappingTemplate":{ "name":"EvaluateMappingTemplate", "http":{ @@ -775,7 +791,8 @@ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, - {"shape":"InternalFailureException"} + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} ] }, "UpdateType":{ @@ -911,6 +928,17 @@ "error":{"httpStatusCode":400}, "exception":true }, + "AppSyncRuntime":{ + "type":"structure", + "required":[ + "name", + "runtimeVersion" + ], + "members":{ + "name":{"shape":"RuntimeName"}, + "runtimeVersion":{"shape":"String"} + } + }, "AssociateApiRequest":{ "type":"structure", "required":[ @@ -969,14 +997,26 @@ "signingServiceName":{"shape":"String"} } }, + "BadRequestDetail":{ + "type":"structure", + "members":{ + "codeErrors":{"shape":"CodeErrors"} + } + }, "BadRequestException":{ "type":"structure", "members":{ - "message":{"shape":"ErrorMessage"} + "message":{"shape":"ErrorMessage"}, + "reason":{"shape":"BadRequestReason"}, + "detail":{"shape":"BadRequestDetail"} }, "error":{"httpStatusCode":400}, "exception":true }, + "BadRequestReason":{ + "type":"string", + "enum":["CODE_ERROR"] + }, "Blob":{"type":"blob"}, "Boolean":{"type":"boolean"}, "BooleanValue":{"type":"boolean"}, @@ -998,6 +1038,34 @@ "min":20, "pattern":"^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" }, + "Code":{ + "type":"string", + "max":32768, + "min":1 + }, + "CodeError":{ + "type":"structure", + "members":{ + "errorType":{"shape":"String"}, + "value":{"shape":"String"}, + "location":{"shape":"CodeErrorLocation"} + } + }, + "CodeErrorColumn":{"type":"integer"}, + "CodeErrorLine":{"type":"integer"}, + "CodeErrorLocation":{ + "type":"structure", + "members":{ + "line":{"shape":"CodeErrorLine"}, + "column":{"shape":"CodeErrorColumn"}, + "span":{"shape":"CodeErrorSpan"} + } + }, + "CodeErrorSpan":{"type":"integer"}, + "CodeErrors":{ + "type":"list", + "member":{"shape":"CodeError"} + }, "CognitoUserPoolConfig":{ "type":"structure", "required":[ @@ -1140,8 +1208,7 @@ "required":[ "apiId", "name", - "dataSourceName", - "functionVersion" + "dataSourceName" ], "members":{ "apiId":{ @@ -1156,7 +1223,9 @@ "responseMappingTemplate":{"shape":"MappingTemplate"}, "functionVersion":{"shape":"String"}, "syncConfig":{"shape":"SyncConfig"}, - "maxBatchSize":{"shape":"MaxBatchSize"} + "maxBatchSize":{"shape":"MaxBatchSize"}, + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"} } }, "CreateFunctionResponse":{ @@ -1215,7 +1284,9 @@ "pipelineConfig":{"shape":"PipelineConfig"}, "syncConfig":{"shape":"SyncConfig"}, "cachingConfig":{"shape":"CachingConfig"}, - "maxBatchSize":{"shape":"MaxBatchSize"} + "maxBatchSize":{"shape":"MaxBatchSize"}, + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"} } }, "CreateResolverResponse":{ @@ -1542,6 +1613,35 @@ } }, "ErrorMessage":{"type":"string"}, + "EvaluateCodeErrorDetail":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "codeErrors":{"shape":"CodeErrors"} + } + }, + "EvaluateCodeRequest":{ + "type":"structure", + "required":[ + "runtime", + "code", + "context" + ], + "members":{ + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"}, + "context":{"shape":"Context"}, + "function":{"shape":"String"} + } + }, + "EvaluateCodeResponse":{ + "type":"structure", + "members":{ + "evaluationResult":{"shape":"EvaluationResult"}, + "error":{"shape":"EvaluateCodeErrorDetail"}, + "logs":{"shape":"Logs"} + } + }, "EvaluateMappingTemplateRequest":{ "type":"structure", "required":[ @@ -1557,7 +1657,8 @@ "type":"structure", "members":{ "evaluationResult":{"shape":"EvaluationResult"}, - "error":{"shape":"ErrorDetail"} + "error":{"shape":"ErrorDetail"}, + "logs":{"shape":"Logs"} } }, "EvaluationResult":{ @@ -1602,7 +1703,9 @@ "responseMappingTemplate":{"shape":"MappingTemplate"}, "functionVersion":{"shape":"String"}, "syncConfig":{"shape":"SyncConfig"}, - "maxBatchSize":{"shape":"MaxBatchSize"} + "maxBatchSize":{"shape":"MaxBatchSize"}, + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"} } }, "Functions":{ @@ -2183,6 +2286,10 @@ "excludeVerboseContent":{"shape":"Boolean"} } }, + "Logs":{ + "type":"list", + "member":{"shape":"String"} + }, "Long":{"type":"long"}, "MapOfStringToString":{ "type":"map", @@ -2287,7 +2394,9 @@ "pipelineConfig":{"shape":"PipelineConfig"}, "syncConfig":{"shape":"SyncConfig"}, "cachingConfig":{"shape":"CachingConfig"}, - "maxBatchSize":{"shape":"MaxBatchSize"} + "maxBatchSize":{"shape":"MaxBatchSize"}, + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"} } }, "ResolverKind":{ @@ -2313,6 +2422,10 @@ "min":1, "pattern":"[_A-Za-z][_0-9A-Za-z]*" }, + "RuntimeName":{ + "type":"string", + "enum":["APPSYNC_JS"] + }, "SchemaStatus":{ "type":"string", "enum":[ @@ -2573,8 +2686,7 @@ "apiId", "name", "functionId", - "dataSourceName", - "functionVersion" + "dataSourceName" ], "members":{ "apiId":{ @@ -2594,7 +2706,9 @@ "responseMappingTemplate":{"shape":"MappingTemplate"}, "functionVersion":{"shape":"String"}, "syncConfig":{"shape":"SyncConfig"}, - "maxBatchSize":{"shape":"MaxBatchSize"} + "maxBatchSize":{"shape":"MaxBatchSize"}, + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"} } }, "UpdateFunctionResponse":{ @@ -2661,7 +2775,9 @@ "pipelineConfig":{"shape":"PipelineConfig"}, "syncConfig":{"shape":"SyncConfig"}, "cachingConfig":{"shape":"CachingConfig"}, - "maxBatchSize":{"shape":"MaxBatchSize"} + "maxBatchSize":{"shape":"MaxBatchSize"}, + "runtime":{"shape":"AppSyncRuntime"}, + "code":{"shape":"Code"} } }, "UpdateResolverResponse":{ diff --git a/models/apis/appsync/2017-07-25/docs-2.json b/models/apis/appsync/2017-07-25/docs-2.json index 2a5a8a8e015..01187ff7016 100644 --- a/models/apis/appsync/2017-07-25/docs-2.json +++ b/models/apis/appsync/2017-07-25/docs-2.json @@ -20,6 +20,7 @@ "DeleteResolver": "Deletes a Resolver object.
Deletes a Type object.
Removes an ApiAssociation object from a custom domain.
Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
", "FlushApiCache": "Flushes an ApiCache object.
Retrieves an ApiAssociation object.
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
", + "refs": { + "CreateFunctionRequest$runtime": null, + "CreateResolverRequest$runtime": null, + "EvaluateCodeRequest$runtime": "The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is supported.
The Identity and Access Management (IAM) settings.
" } }, + "BadRequestDetail": { + "base": "Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
", "refs": { } }, + "BadRequestReason": { + "base": "Provides context for the cause of the bad request. The only supported value is CODE_ERROR.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
" } }, + "Code": { + "base": null, + "refs": { + "CreateFunctionRequest$code": "The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
Describes an AppSync error.
", + "refs": { + "CodeErrors$member": null + } + }, + "CodeErrorColumn": { + "base": null, + "refs": { + "CodeErrorLocation$column": "The column number in the code. Defaults to 0 if unknown.
The line number in the code. Defaults to 0 if unknown.
Describes the location of the error in a code sample.
", + "refs": { + "CodeError$location": "The line, column, and span location of the error in the code.
" + } + }, + "CodeErrorSpan": { + "base": null, + "refs": { + "CodeErrorLocation$span": "The span/length of the error. Defaults to -1 if unknown.
Contains the list of errors in the request.
", + "EvaluateCodeErrorDetail$codeErrors": "Contains the list of CodeError objects.
Describes an Amazon Cognito user pool configuration.
", "refs": { @@ -262,6 +336,7 @@ "Context": { "base": null, "refs": { + "EvaluateCodeRequest$context": "The map that holds all of the contextual information for your resolver invocation. A context is required for this action.
The map that holds all of the contextual information for your resolver invocation. A context is required for this action.
Contains the list of errors generated when attempting to evaluate a mapping template.
", + "base": "Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.
", "refs": { "EvaluateMappingTemplateResponse$error": "The ErrorDetail object.
The error payload.
", + "EvaluateCodeErrorDetail$message": "The error payload.
", "GraphQLSchemaException$message": null } }, + "EvaluateCodeErrorDetail": { + "base": "Contains the list of errors from a code evaluation response.
", + "refs": { + "EvaluateCodeResponse$error": "Contains the payload of the response error.
" + } + }, + "EvaluateCodeRequest": { + "base": null, + "refs": { + } + }, + "EvaluateCodeResponse": { + "base": null, + "refs": { + } + }, "EvaluateMappingTemplateRequest": { "base": null, "refs": { @@ -551,6 +643,7 @@ "EvaluationResult": { "base": null, "refs": { + "EvaluateCodeResponse$evaluationResult": "The result of the evaluation operation.
", "EvaluateMappingTemplateResponse$evaluationResult": "The mapping template; this can be a request or response template.
" } }, @@ -850,6 +943,13 @@ "UpdateGraphqlApiRequest$logConfig": "The Amazon CloudWatch Logs configuration for the GraphqlApi object.
A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.
A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.
The new type name.
" } }, + "RuntimeName": { + "base": null, + "refs": { + "AppSyncRuntime$name": "The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
The version of the runtime to use. Currently, the only allowed version is 1.0.0.
The API ID.
", "AwsIamConfig$signingRegion": "The signing Amazon Web Services Region for IAM authorization.
", "AwsIamConfig$signingServiceName": "The signing service name for IAM authorization.
", "CachingKeys$member": null, + "CodeError$errorType": "The type of code error.
Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
A user presentable error.
Examples include, but aren't limited to: Parsing error: Unterminated string literal.
The user pool ID.
", "CognitoUserPoolConfig$awsRegion": "The Amazon Web Services Region in which the user pool was created.
", "CognitoUserPoolConfig$appIdClientRegex": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
", @@ -1103,7 +1212,7 @@ "CreateDataSourceRequest$serviceRoleArn": "The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.
", "CreateFunctionRequest$apiId": "The GraphQL API ID.
", "CreateFunctionRequest$description": "The Function description.
The version of the request mapping template. Currently, the supported value is 2018-05-29.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.
A user-supplied name for the GraphqlApi.
The ID for the GraphQL API for which the resolver is being created.
", "CreateTypeRequest$apiId": "The API ID.
", @@ -1126,6 +1235,7 @@ "DynamodbDataSourceConfig$awsRegion": "The Amazon Web Services Region.
", "ElasticsearchDataSourceConfig$endpoint": "The endpoint.
", "ElasticsearchDataSourceConfig$awsRegion": "The Amazon Web Services Region.
", + "EvaluateCodeRequest$function": "The function within the code to be evaluated. If provided, the valid values are request and response.
The API ID.
", "FunctionConfiguration$functionId": "A unique ID representing the Function object.
The Amazon Resource Name (ARN) of the Function object.
The type name.
", "ListTypesRequest$apiId": "The API ID.
", "LogConfig$cloudWatchLogsRoleArn": "The service role that AppSync assumes to publish to CloudWatch logs in your account.
", + "Logs$member": null, "MapOfStringToString$key": null, "MapOfStringToString$value": null, "NotFoundException$message": null, @@ -1187,7 +1298,7 @@ "UpdateDataSourceRequest$serviceRoleArn": "The new service role Amazon Resource Name (ARN) for the data source.
", "UpdateFunctionRequest$apiId": "The GraphQL API ID.
", "UpdateFunctionRequest$description": "The Function description.
The version of the request mapping template. Currently, the supported value is 2018-05-29.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.
The API ID.
", "UpdateGraphqlApiRequest$name": "The new name for the GraphqlApi object.
The API ID.
", diff --git a/models/apis/appsync/2017-07-25/endpoint-rule-set-1.json b/models/apis/appsync/2017-07-25/endpoint-rule-set-1.json new file mode 100644 index 00000000000..16d865934f0 --- /dev/null +++ b/models/apis/appsync/2017-07-25/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://appsync.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/appsync/2017-07-25/endpoint-tests-1.json b/models/apis/appsync/2017-07-25/endpoint-tests-1.json new file mode 100644 index 00000000000..a0747045ec9 --- /dev/null +++ b/models/apis/appsync/2017-07-25/endpoint-tests-1.json @@ -0,0 +1,1291 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/dms/2016-01-01/api-2.json b/models/apis/dms/2016-01-01/api-2.json index 6d03b968ddf..cdb7fa4ac4e 100644 --- a/models/apis/dms/2016-01-01/api-2.json +++ b/models/apis/dms/2016-01-01/api-2.json @@ -1224,7 +1224,8 @@ "KmsKeyId":{"shape":"String"}, "PubliclyAccessible":{"shape":"BooleanOptional"}, "DnsNameServers":{"shape":"String"}, - "ResourceIdentifier":{"shape":"String"} + "ResourceIdentifier":{"shape":"String"}, + "NetworkType":{"shape":"String"} } }, "CreateReplicationInstanceResponse":{ @@ -2468,7 +2469,8 @@ "EngineVersion":{"shape":"String"}, "AllowMajorVersionUpgrade":{"shape":"Boolean"}, "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, - "ReplicationInstanceIdentifier":{"shape":"String"} + "ReplicationInstanceIdentifier":{"shape":"String"}, + "NetworkType":{"shape":"String"} } }, "ModifyReplicationInstanceResponse":{ @@ -2905,12 +2907,18 @@ }, "ReplicationInstancePublicIpAddresses":{"shape":"ReplicationInstancePublicIpAddressList"}, "ReplicationInstancePrivateIpAddresses":{"shape":"ReplicationInstancePrivateIpAddressList"}, + "ReplicationInstanceIpv6Addresses":{"shape":"ReplicationInstanceIpv6AddressList"}, "PubliclyAccessible":{"shape":"Boolean"}, "SecondaryAvailabilityZone":{"shape":"String"}, "FreeUntil":{"shape":"TStamp"}, - "DnsNameServers":{"shape":"String"} + "DnsNameServers":{"shape":"String"}, + "NetworkType":{"shape":"String"} } }, + "ReplicationInstanceIpv6AddressList":{ + "type":"list", + "member":{"shape":"String"} + }, "ReplicationInstanceList":{ "type":"list", "member":{"shape":"ReplicationInstance"} @@ -2941,7 +2949,8 @@ "ReplicationInstanceClass":{"shape":"String"}, "AllocatedStorage":{"shape":"IntegerOptional"}, "MultiAZ":{"shape":"BooleanOptional"}, - "EngineVersion":{"shape":"String"} + "EngineVersion":{"shape":"String"}, + "NetworkType":{"shape":"String"} } }, "ReplicationSubnetGroup":{ @@ -2951,7 +2960,8 @@ "ReplicationSubnetGroupDescription":{"shape":"String"}, "VpcId":{"shape":"String"}, "SubnetGroupStatus":{"shape":"String"}, - "Subnets":{"shape":"SubnetList"} + "Subnets":{"shape":"SubnetList"}, + "SupportedNetworkTypes":{"shape":"StringList"} } }, "ReplicationSubnetGroupDoesNotCoverEnoughAZs":{ @@ -3395,6 +3405,10 @@ "Deletes":{"shape":"Long"}, "Updates":{"shape":"Long"}, "Ddls":{"shape":"Long"}, + "AppliedInserts":{"shape":"LongOptional"}, + "AppliedDeletes":{"shape":"LongOptional"}, + "AppliedUpdates":{"shape":"LongOptional"}, + "AppliedDdls":{"shape":"LongOptional"}, "FullLoadRows":{"shape":"Long"}, "FullLoadCondtnlChkFailedRows":{"shape":"Long"}, "FullLoadErrorRows":{"shape":"Long"}, diff --git a/models/apis/dms/2016-01-01/docs-2.json b/models/apis/dms/2016-01-01/docs-2.json index 46b73dc67a1..07245e216f0 100644 --- a/models/apis/dms/2016-01-01/docs-2.json +++ b/models/apis/dms/2016-01-01/docs-2.json @@ -196,7 +196,7 @@ "OracleSettings$ReplacePathPrefix": "Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
", "OracleSettings$DirectPathNoLog": "When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.
When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the DMS user account needs to be granted ASM privileges.
When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.
When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.
If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
When set to true, this attribute supports tablespace replication.
The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.
If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).
The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.
", "S3Settings$CdcMaxBatchInterval": "Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
When CdcMaxBatchInterval and CdcMinFileSize are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.
The default value is 60 seconds.
", - "S3Settings$CdcMinFileSize": "Minimum file size, defined in megabytes, to reach for a file output to Amazon S3.
When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.
The default value is 32 MB.
", + "S3Settings$CdcMinFileSize": "Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.
The default value is 32 MB.
", "S3Settings$IgnoreHeaderRows": "When this value is set to 1, DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.
The default is 0.
", "S3Settings$MaxFileSize": "A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.
The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.
", "SybaseSettings$Port": "Endpoint TCP port. The default is 5000.
" @@ -1338,7 +1338,11 @@ "FleetAdvisorSchemaObjectResponse$CodeLineCount": "The number of lines of code in a schema object in a Fleet Advisor collector inventory.
", "FleetAdvisorSchemaObjectResponse$CodeSize": "The size level of the code in a schema object in a Fleet Advisor collector inventory.
", "SchemaResponse$CodeLineCount": "The number of lines of code in a schema in a Fleet Advisor collector inventory.
", - "SchemaResponse$CodeSize": "The size level of the code in a schema in a Fleet Advisor collector inventory.
" + "SchemaResponse$CodeSize": "The size level of the code in a schema in a Fleet Advisor collector inventory.
", + "TableStatistics$AppliedInserts": "The number of insert actions applied on a target table.
", + "TableStatistics$AppliedDeletes": "The number of delete actions applied on a target table.
", + "TableStatistics$AppliedUpdates": "The number of update actions applied on a target table.
", + "TableStatistics$AppliedDdls": "The number of data definition language (DDL) statements used to build and modify the structure of your tables applied on the target.
" } }, "MessageFormatValue": { @@ -1620,6 +1624,12 @@ "ReplicationInstanceList$member": null } }, + "ReplicationInstanceIpv6AddressList": { + "base": null, + "refs": { + "ReplicationInstance$ReplicationInstanceIpv6Addresses": "One or more IPv6 addresses for the replication instance.
" + } + }, "ReplicationInstanceList": { "base": null, "refs": { @@ -1968,7 +1978,7 @@ "Connection$EndpointIdentifier": "The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
", "Connection$ReplicationInstanceIdentifier": "The replication instance identifier. This parameter is stored as a lowercase string.
", "CreateEndpointMessage$EndpointIdentifier": "The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
", - "CreateEndpointMessage$EngineName": "The type of engine for the endpoint. Valid values, depending on the EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\", \"sqlserver\", and \"neptune\".
The type of engine for the endpoint. Valid values, depending on the EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\", \"sqlserver\", \"neptune\", and \"babelfish\".
The user name to be used to log in to the endpoint database.
", "CreateEndpointMessage$ServerName": "The name of the server where the endpoint database resides.
", "CreateEndpointMessage$DatabaseName": "The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
", "CreateReplicationInstanceMessage$DnsNameServers": "A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
", "CreateReplicationSubnetGroupMessage$ReplicationSubnetGroupIdentifier": "The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be \"default\".
Example: mySubnetgroup
The description for the subnet group.
", "CreateReplicationTaskMessage$ReplicationTaskIdentifier": "An identifier for the replication task.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
", "Endpoint$EndpointIdentifier": "The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
", - "Endpoint$EngineName": "The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".
The expanded name for the engine name. For example, if the EngineName parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"
The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", \"neptune\", and \"babelfish\".
The expanded name for the engine name. For example, if the EngineName parameter is \"aurora\", this value would be \"Amazon Aurora MySQL\".
The user name used to connect to the endpoint.
", "Endpoint$ServerName": "The name of the server at the endpoint.
", "Endpoint$DatabaseName": "The name of the database at the endpoint.
", @@ -2181,7 +2192,7 @@ "MicrosoftSQLServerSettings$SecretsManagerSecretId": "The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", "ModifyEndpointMessage$EndpointIdentifier": "The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
", - "ModifyEndpointMessage$EngineName": "The type of engine for the endpoint. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".
The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", \"neptune\", and \"babelfish\".
The user name to be used to login to the endpoint database.
", "ModifyEndpointMessage$ServerName": "The name of the server where the endpoint database resides.
", "ModifyEndpointMessage$DatabaseName": "The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
", @@ -2197,6 +2208,7 @@ "ModifyReplicationInstanceMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", "ModifyReplicationInstanceMessage$EngineVersion": "The engine version number of the replication instance.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
The replication instance identifier. This parameter is stored as a lowercase string.
", + "ModifyReplicationInstanceMessage$NetworkType": "The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
", "ModifyReplicationSubnetGroupMessage$ReplicationSubnetGroupIdentifier": "The name of the replication instance subnet group.
", "ModifyReplicationSubnetGroupMessage$ReplicationSubnetGroupDescription": "A description for the replication instance subnet group.
", "ModifyReplicationTaskMessage$ReplicationTaskArn": "The Amazon Resource Name (ARN) of the replication task.
", @@ -2238,8 +2250,8 @@ "OracleSettings$Username": "Endpoint connection user name.
", "OracleSettings$SecretsManagerAccessRoleArn": "The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
The version of the replication engine.
", "OrderableReplicationInstance$ReplicationInstanceClass": "The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
", "OrderableReplicationInstance$StorageType": "The type of storage used by the replication instance.
", @@ -2293,12 +2305,15 @@ "ReplicationInstance$ReplicationInstancePrivateIpAddress": "The private IP address of the replication instance.
", "ReplicationInstance$SecondaryAvailabilityZone": "The Availability Zone of the standby replication instance in a Multi-AZ deployment.
", "ReplicationInstance$DnsNameServers": "The DNS name servers supported for the replication instance to access your on-premise source or target database.
", + "ReplicationInstance$NetworkType": "The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
", + "ReplicationInstanceIpv6AddressList$member": null, "ReplicationInstancePrivateIpAddressList$member": null, "ReplicationInstancePublicIpAddressList$member": null, "ReplicationInstanceTaskLog$ReplicationTaskName": "The name of the replication task.
", "ReplicationInstanceTaskLog$ReplicationTaskArn": "The Amazon Resource Name (ARN) of the replication task.
", "ReplicationPendingModifiedValues$ReplicationInstanceClass": "The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
", "ReplicationPendingModifiedValues$EngineVersion": "The engine version number of the replication instance.
", + "ReplicationPendingModifiedValues$NetworkType": "The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
", "ReplicationSubnetGroup$ReplicationSubnetGroupIdentifier": "The identifier of the replication instance subnet group.
", "ReplicationSubnetGroup$ReplicationSubnetGroupDescription": "A description for the replication subnet group.
", "ReplicationSubnetGroup$VpcId": "The ID of the VPC.
", @@ -2383,9 +2398,9 @@ "Subnet$SubnetIdentifier": "The subnet identifier.
", "Subnet$SubnetStatus": "The status of the subnet.
", "SubnetIdentifierList$member": null, - "SupportedEndpointType$EngineName": "The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".
The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", \"neptune\", and \"babelfish\".
The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.
", - "SupportedEndpointType$EngineDisplayName": "The expanded name for the engine name. For example, if the EngineName parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"
The expanded name for the engine name. For example, if the EngineName parameter is \"aurora\", this value would be \"Amazon Aurora MySQL\".
Database name for the endpoint.
", "SybaseSettings$ServerName": "Fully qualified domain name of the endpoint.
", "SybaseSettings$Username": "Endpoint connection user name.
", @@ -2413,7 +2428,8 @@ "base": null, "refs": { "DeleteFleetAdvisorDatabasesRequest$DatabaseIds": "The IDs of the Fleet Advisor collector databases to delete.
", - "DeleteFleetAdvisorDatabasesResponse$DatabaseIds": "The IDs of the databases that the operation deleted.
" + "DeleteFleetAdvisorDatabasesResponse$DatabaseIds": "The IDs of the databases that the operation deleted.
", + "ReplicationSubnetGroup$SupportedNetworkTypes": "The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
" } }, "Subnet": { diff --git a/models/apis/dms/2016-01-01/endpoint-rule-set-1.json b/models/apis/dms/2016-01-01/endpoint-rule-set-1.json new file mode 100644 index 00000000000..86a1825eda0 --- /dev/null +++ b/models/apis/dms/2016-01-01/endpoint-rule-set-1.json @@ -0,0 +1,466 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "dms" + ] + } + ], + "endpoint": { + "url": "https://dms-fips.us-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "dms" + ] + } + ], + "endpoint": { + "url": "https://dms.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://dms.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "dms" + ] + } + ], + "endpoint": { + "url": "https://dms.us-iso-east-1.c2s.ic.gov", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-iso", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://dms.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "dms" + ] + } + ], + "endpoint": { + "url": "https://dms.us-isob-east-1.sc2s.sgov.gov", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-iso-b", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://dms.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dms-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dms.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://dms.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/dms/2016-01-01/endpoint-tests-1.json b/models/apis/dms/2016-01-01/endpoint-tests-1.json new file mode 100644 index 00000000000..ed11166de91 --- /dev/null +++ b/models/apis/dms/2016-01-01/endpoint-tests-1.json @@ -0,0 +1,1727 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-south-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-south-2" + } + }, + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-south-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-south-2" + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-south-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-south-2" + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-south-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-south-2" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-south-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-south-2" + } + }, + { + "documentation": "For region eu-south-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-south-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-south-2" + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-south-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-south-2" + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-south-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-south-2" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "me-central-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "me-central-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "me-central-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "me-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-central-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-central-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-central-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-central-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-4" + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-southeast-4" + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-4.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-4" + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-4" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dms.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dms.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 053b1ab382c..0dff1ccc4c6 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -10072,7 +10072,8 @@ "shape":"TagSpecificationList", "locationName":"TagSpecification" }, - "ConnectivityType":{"shape":"ConnectivityType"} + "ConnectivityType":{"shape":"ConnectivityType"}, + "PrivateIpAddress":{"shape":"String"} } }, "CreateNatGatewayResult":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index 9a73b0d4a50..c9087ef4060 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -977,7 +977,7 @@ "AllocationStrategy": { "base": null, "refs": { - "SpotFleetRequestConfigData$AllocationStrategy": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you specify.
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowestPrice
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
lowestPrice - Spot Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.
diversified - Spot Fleet launches instances from all of the Spot Instance pools that you specify.
capacityOptimized (recommended) - Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Default: lowestPrice
The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.
Constraints: Maximum of 1000 resources
" + "CreateFlowLogsRequest$ResourceIds": "The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.
Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.
" } }, "FlowLogSet": { @@ -10743,7 +10743,7 @@ "CreateClientVpnEndpointRequest$VpnPort": "The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
", - "CreateFlowLogsRequest$MaxAggregationInterval": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
", + "CreateFlowLogsRequest$MaxAggregationInterval": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
", "CreateManagedPrefixListRequest$MaxEntries": "The maximum number of entries for the prefix list.
", "CreateNetworkAclEntryRequest$RuleNumber": "The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
", "CreateNetworkInterfaceRequest$Ipv6AddressCount": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.
You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowest-price
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowest-price
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.
diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Default: lowest-price
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.
diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Default: lowest-price
The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
", "CreateFlowLogsRequest$LogGroupName": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
This parameter is valid only if the destination type is cloud-watch-logs.
The destination for the flow log data. The meaning of this parameter depends on the destination type.
If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs:region:account_id:log-group:my_group
Alternatively, use the LogGroupName parameter.
If the destination type is s3, specify the ARN of an S3 bucket. For example:
arn:aws:s3:::my_bucket/my_subfolder/
The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.
If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose:region:account_id:deliverystream:my_stream
The fields to include in the flow log record. List the fields in the order in which they should appear. For more information about the available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateFpgaImageRequest$Description": "A description for the AFI.
", "CreateFpgaImageRequest$Name": "A name for the AFI.
", @@ -17215,6 +17215,7 @@ "CreateManagedPrefixListRequest$AddressFamily": "The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
", "CreateNatGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Constraint: Maximum 64 ASCII characters.
", + "CreateNatGatewayRequest$PrivateIpAddress": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
", "CreateNatGatewayResult$ClientToken": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "CreateNetworkAclEntryRequest$CidrBlock": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
", + "CreateFlowLogsRequest$TrafficType": "The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.
", "FlowLog$TrafficType": "The type of traffic captured for the flow log.
" } }, diff --git a/models/apis/ec2/2016-11-15/endpoint-tests-1.json b/models/apis/ec2/2016-11-15/endpoint-tests-1.json index 96d0b0e0c6c..b6fa8ed123c 100644 --- a/models/apis/ec2/2016-11-15/endpoint-tests-1.json +++ b/models/apis/ec2/2016-11-15/endpoint-tests-1.json @@ -620,6 +620,54 @@ "UseDualStack": false } }, + { + "documentation": "For region us-isob-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-isob-west-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-isob-west-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-west-1", + "UseDualStack": false + } + }, { "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", "expect": { diff --git a/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json b/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json index 8a245797b0b..4bfa4963440 100644 --- a/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json +++ b/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json @@ -27,7 +27,7 @@ "ModifyListener": "Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
", "ModifyLoadBalancerAttributes": "Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
", "ModifyRule": "Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
", - "ModifyTargetGroup": "Modifies the health checks used when evaluating the health state of the targets in the specified target group.
If the protocol of the target group is TCP, TLS, UDP, or TCP_UDP, you can't modify the health check protocol, interval, timeout, or success codes.
", + "ModifyTargetGroup": "Modifies the health checks used when evaluating the health state of the targets in the specified target group.
", "ModifyTargetGroupAttributes": "Modifies the specified attributes of the specified target group.
", "RegisterTargets": "Registers the specified targets with the specified target group.
If the target is an EC2 instance, it must be in the running state when you register it.
By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.
With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.
", "RemoveListenerCertificates": "Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
", @@ -655,8 +655,8 @@ "HealthCheckIntervalSeconds": { "base": null, "refs": { - "CreateTargetGroupInput$HealthCheckIntervalSeconds": "The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds and the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds.
The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.
", + "CreateTargetGroupInput$HealthCheckIntervalSeconds": "The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds.
The approximate amount of time, in seconds, between health checks of an individual target.
", "TargetGroup$HealthCheckIntervalSeconds": "The approximate amount of time, in seconds, between health checks of an individual target.
" } }, @@ -672,10 +672,10 @@ "HealthCheckThresholdCount": { "base": null, "refs": { - "CreateTargetGroupInput$HealthyThresholdCount": "The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is lambda, the default is 5.
The number of consecutive health check failures required before considering a target unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is lambda, the default is 2.
The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 3. If the target type is lambda, the default is 5.
The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 3. If the target type is lambda, the default is 5.
The number of consecutive health checks successes required before considering an unhealthy target healthy.
", - "ModifyTargetGroupInput$UnhealthyThresholdCount": "The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.
", + "ModifyTargetGroupInput$UnhealthyThresholdCount": "The number of consecutive health check failures required before considering the target unhealthy.
", "TargetGroup$HealthyThresholdCount": "The number of consecutive health checks successes required before considering an unhealthy target healthy.
", "TargetGroup$UnhealthyThresholdCount": "The number of consecutive health check failures required before considering the target unhealthy.
" } @@ -683,7 +683,7 @@ "HealthCheckTimeoutSeconds": { "base": null, "refs": { - "CreateTargetGroupInput$HealthCheckTimeoutSeconds": "The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.
The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
", "TargetGroup$HealthCheckTimeoutSeconds": "The amount of time, in seconds, during which no response means a failed health check.
" } @@ -702,7 +702,7 @@ "HttpCode": { "base": null, "refs": { - "Matcher$HttpCode": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").
For Network Load Balancers and Gateway Load Balancers, this must be \"200–399\".
Note that when using shorthand syntax, some values such as commas need to be escaped.
" + "Matcher$HttpCode": "For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").
For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").
For Gateway Load Balancers, this must be \"200–399\".
Note that when using shorthand syntax, some values such as commas need to be escaped.
" } }, "HttpHeaderConditionConfig": { @@ -803,12 +803,12 @@ "ListOfString": { "base": null, "refs": { - "HostHeaderConditionConfig$Values": "One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
", - "HttpHeaderConditionConfig$Values": "One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
", + "HostHeaderConditionConfig$Values": "The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
", + "HttpHeaderConditionConfig$Values": "The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
", "HttpRequestMethodConditionConfig$Values": "The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
", - "PathPatternConditionConfig$Values": "One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.
", + "PathPatternConditionConfig$Values": "The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.
", "RuleCondition$Values": "The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.
If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
- .
* (matches 0 or more characters)
? (matches exactly 1 character)
If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
_ - . $ / ~ \" ' @ : +
& (using &)
* (matches 0 or more characters)
? (matches exactly 1 character)
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
", + "SourceIpConditionConfig$Values": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
", "SslPolicy$SupportedLoadBalancerTypes": "The supported load balancers.
" } }, @@ -902,7 +902,7 @@ "LoadBalancerAttributeKey": { "base": null, "refs": { - "LoadBalancerAttribute$Key": "The name of the attribute.
The following attribute is supported by all load balancers:
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.
routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false.
routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.
routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.
routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.
If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.
If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.
routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default is false.
The name of the attribute.
The following attributes are supported by all load balancers:
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.
routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false.
routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.
routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.
routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.
If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.
If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.
routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.
The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.
", "refs": { - "CreateTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
", - "ModifyTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
", + "CreateTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
", + "ModifyTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
", "TargetGroup$Matcher": "The HTTP or gRPC codes to use when checking for a successful response from a target.
" } }, @@ -1156,7 +1156,7 @@ "QueryStringKeyValuePairList": { "base": null, "refs": { - "QueryStringConditionConfig$Values": "One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '\\' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
" + "QueryStringConditionConfig$Values": "The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '\\' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
" } }, "RedirectActionConfig": { @@ -1584,7 +1584,7 @@ "TargetGroupAttributeKey": { "base": null, "refs": { - "TargetGroupAttribute$Key": "The name of the attribute.
The following attribute is supported by all load balancers:
deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
The following attributes are supported by Application Load Balancers, Network Load Balancers, and Gateway Load Balancers:
stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false.
stickiness.type - Indicates the type of stickiness. The possible values are:
lb_cookie and app_cookie for Application Load Balancers.
source_ip for Network Load Balancers.
source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin.
slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.
stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false.
preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.
proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
The following attributes are supported only by Gateway Load Balancers:
target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same.
target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes must be the same.
The name of the attribute.
The following attributes are supported by all load balancers:
deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false.
stickiness.type - Indicates the type of stickiness. The possible values are:
lb_cookie and app_cookie for Application Load Balancers.
source_ip for Network Load Balancers.
source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and Network Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross zone load balancing is enabled. The value is true, false or use_load_balancer_configuration. The default is use_load_balancer_configuration.
target_group_health.dns_failover.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to the maximum number of targets. The default is off.
target_group_health.dns_failover.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to 100. The default is off.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are off or an integer from 1 to 100. The default is off.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin.
slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.
stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false.
preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.
proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
The following attributes are supported only by Gateway Load Balancers:
target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same.
target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes must be the same.
One or more target groups. For Network Load Balancers, you can specify a single target group.
" + "ForwardActionConfig$TargetGroups": "The target groups. For Network Load Balancers, you can specify a single target group.
" } }, "TargetGroupName": { @@ -1781,7 +1781,7 @@ "base": null, "refs": { "AvailabilityZone$ZoneName": "The name of the Availability Zone.
", - "TargetDescription$AvailabilityZone": "An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance or alb.
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
If the target type is lambda, this parameter is optional and the only supported value is all.
An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.
This parameter is not supported if the target type of the target group is instance or alb.
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.
If the target type is lambda, this parameter is optional and the only supported value is all.
The CPU architecture of an application.
", + "ApplicationSummary$architecture": "The CPU architecture of an application.
", + "CreateApplicationRequest$architecture": "The CPU architecture of an application.
", + "UpdateApplicationRequest$architecture": "The CPU architecture of an application.
" + } + }, "AutoStartConfig": { "base": "The configuration for an application to automatically start on job submission.
", "refs": { diff --git a/models/apis/emr-serverless/2021-07-13/endpoint-rule-set-1.json b/models/apis/emr-serverless/2021-07-13/endpoint-rule-set-1.json new file mode 100644 index 00000000000..ee8606e1b98 --- /dev/null +++ b/models/apis/emr-serverless/2021-07-13/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/emr-serverless/2021-07-13/endpoint-tests-1.json b/models/apis/emr-serverless/2021-07-13/endpoint-tests-1.json new file mode 100644 index 00000000000..54428a96459 --- /dev/null +++ b/models/apis/emr-serverless/2021-07-13/endpoint-tests-1.json @@ -0,0 +1,927 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/ivschat/2020-07-14/api-2.json b/models/apis/ivschat/2020-07-14/api-2.json index 72f2b51cc94..2bd0466f2fe 100644 --- a/models/apis/ivschat/2020-07-14/api-2.json +++ b/models/apis/ivschat/2020-07-14/api-2.json @@ -29,6 +29,24 @@ {"shape":"ValidationException"} ] }, + "CreateLoggingConfiguration":{ + "name":"CreateLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/CreateLoggingConfiguration", + "responseCode":200 + }, + "input":{"shape":"CreateLoggingConfigurationRequest"}, + "output":{"shape":"CreateLoggingConfigurationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ] + }, "CreateRoom":{ "name":"CreateRoom", "http":{ @@ -47,6 +65,22 @@ {"shape":"ValidationException"} ] }, + "DeleteLoggingConfiguration":{ + "name":"DeleteLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/DeleteLoggingConfiguration", + "responseCode":204 + }, + "input":{"shape":"DeleteLoggingConfigurationRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ] + }, "DeleteMessage":{ "name":"DeleteMessage", "http":{ @@ -94,6 +128,21 @@ {"shape":"ValidationException"} ] }, + "GetLoggingConfiguration":{ + "name":"GetLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/GetLoggingConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetLoggingConfigurationRequest"}, + "output":{"shape":"GetLoggingConfigurationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, "GetRoom":{ "name":"GetRoom", "http":{ @@ -109,6 +158,20 @@ {"shape":"ValidationException"} ] }, + "ListLoggingConfigurations":{ + "name":"ListLoggingConfigurations", + "http":{ + "method":"POST", + "requestUri":"/ListLoggingConfigurations", + "responseCode":200 + }, + "input":{"shape":"ListLoggingConfigurationsRequest"}, + "output":{"shape":"ListLoggingConfigurationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ] + }, "ListRooms":{ "name":"ListRooms", "http":{ @@ -186,6 +249,22 @@ ], "idempotent":true }, + "UpdateLoggingConfiguration":{ + "name":"UpdateLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/UpdateLoggingConfiguration", + "responseCode":200 + }, + "input":{"shape":"UpdateLoggingConfigurationRequest"}, + "output":{"shape":"UpdateLoggingConfigurationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ] + }, "UpdateRoom":{ "name":"UpdateRoom", "http":{ @@ -216,6 +295,12 @@ }, "exception":true }, + "BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[a-z0-9-.]+$" + }, "ChatToken":{"type":"string"}, "ChatTokenAttributes":{ "type":"map", @@ -234,6 +319,13 @@ "DELETE_MESSAGE" ] }, + "CloudWatchLogsDestinationConfiguration":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, "ConflictException":{ "type":"structure", "required":[ @@ -274,9 +366,36 @@ "tokenExpirationTime":{"shape":"Time"} } }, + "CreateLoggingConfigurationRequest":{ + "type":"structure", + "required":["destinationConfiguration"], + "members":{ + "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "name":{"shape":"LoggingConfigurationName"}, + "tags":{"shape":"Tags"} + } + }, + "CreateLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"LoggingConfigurationArn"}, + "createTime":{"shape":"Time"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "id":{"shape":"LoggingConfigurationID"}, + "name":{"shape":"LoggingConfigurationName"}, + "state":{"shape":"CreateLoggingConfigurationState"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "CreateLoggingConfigurationState":{ + "type":"string", + "enum":["ACTIVE"] + }, "CreateRoomRequest":{ "type":"structure", "members":{ + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, @@ -290,6 +409,7 @@ "arn":{"shape":"RoomArn"}, "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, @@ -298,6 +418,13 @@ "updateTime":{"shape":"Time"} } }, + "DeleteLoggingConfigurationRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{"shape":"LoggingConfigurationIdentifier"} + } + }, "DeleteMessageRequest":{ "type":"structure", "required":[ @@ -323,6 +450,21 @@ "identifier":{"shape":"RoomIdentifier"} } }, + "DeliveryStreamName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9_.-]+$" + }, + "DestinationConfiguration":{ + "type":"structure", + "members":{ + "cloudWatchLogs":{"shape":"CloudWatchLogsDestinationConfiguration"}, + "firehose":{"shape":"FirehoseDestinationConfiguration"}, + "s3":{"shape":"S3DestinationConfiguration"} + }, + "union":true + }, "DisconnectUserRequest":{ "type":"structure", "required":[ @@ -359,6 +501,33 @@ ] }, "FieldName":{"type":"string"}, + "FirehoseDestinationConfiguration":{ + "type":"structure", + "required":["deliveryStreamName"], + "members":{ + "deliveryStreamName":{"shape":"DeliveryStreamName"} + } + }, + "GetLoggingConfigurationRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{"shape":"LoggingConfigurationIdentifier"} + } + }, + "GetLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"LoggingConfigurationArn"}, + "createTime":{"shape":"Time"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "id":{"shape":"LoggingConfigurationID"}, + "name":{"shape":"LoggingConfigurationName"}, + "state":{"shape":"LoggingConfigurationState"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, "GetRoomRequest":{ "type":"structure", "required":["identifier"], @@ -372,6 +541,7 @@ "arn":{"shape":"RoomArn"}, "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, @@ -403,9 +573,25 @@ "pattern":"^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+" }, "Limit":{"type":"integer"}, + "ListLoggingConfigurationsRequest":{ + "type":"structure", + "members":{ + "maxResults":{"shape":"MaxLoggingConfigurationResults"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListLoggingConfigurationsResponse":{ + "type":"structure", + "required":["loggingConfigurations"], + "members":{ + "loggingConfigurations":{"shape":"LoggingConfigurationList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, "ListRoomsRequest":{ "type":"structure", "members":{ + "loggingConfigurationIdentifier":{"shape":"LoggingConfigurationIdentifier"}, "maxResults":{"shape":"MaxRoomResults"}, "messageReviewHandlerUri":{"shape":"LambdaArn"}, "name":{"shape":"RoomName"}, @@ -438,6 +624,76 @@ "tags":{"shape":"Tags"} } }, + "LogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"^[\\.\\-_/#A-Za-z0-9]+$" + }, + "LoggingConfigurationArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$" + }, + "LoggingConfigurationID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[a-zA-Z0-9]+$" + }, + "LoggingConfigurationIdentifier":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$" + }, + "LoggingConfigurationIdentifierList":{ + "type":"list", + "member":{"shape":"LoggingConfigurationIdentifier"}, + "max":3, + "min":0 + }, + "LoggingConfigurationList":{ + "type":"list", + "member":{"shape":"LoggingConfigurationSummary"} + }, + "LoggingConfigurationName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^[a-zA-Z0-9-_]*$" + }, + "LoggingConfigurationState":{ + "type":"string", + "enum":[ + "CREATING", + "CREATE_FAILED", + "DELETING", + "DELETE_FAILED", + "UPDATING", + "UPDATE_FAILED", + "ACTIVE" + ] + }, + "LoggingConfigurationSummary":{ + "type":"structure", + "members":{ + "arn":{"shape":"LoggingConfigurationArn"}, + "createTime":{"shape":"Time"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "id":{"shape":"LoggingConfigurationID"}, + "name":{"shape":"LoggingConfigurationName"}, + "state":{"shape":"LoggingConfigurationState"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "MaxLoggingConfigurationResults":{ + "type":"integer", + "max":50, + "min":1 + }, "MaxRoomResults":{ "type":"integer", "max":50, @@ -554,12 +810,20 @@ "arn":{"shape":"RoomArn"}, "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, "name":{"shape":"RoomName"}, "tags":{"shape":"Tags"}, "updateTime":{"shape":"Time"} } }, + "S3DestinationConfiguration":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{"shape":"BucketName"} + } + }, "SendEventRequest":{ "type":"structure", "required":[ @@ -695,11 +959,38 @@ "members":{ } }, + "UpdateLoggingConfigurationRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "identifier":{"shape":"LoggingConfigurationIdentifier"}, + "name":{"shape":"LoggingConfigurationName"} + } + }, + "UpdateLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"LoggingConfigurationArn"}, + "createTime":{"shape":"Time"}, + "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "id":{"shape":"LoggingConfigurationID"}, + "name":{"shape":"LoggingConfigurationName"}, + "state":{"shape":"UpdateLoggingConfigurationState"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "UpdateLoggingConfigurationState":{ + "type":"string", + "enum":["ACTIVE"] + }, "UpdateRoomRequest":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{"shape":"RoomIdentifier"}, + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, @@ -712,6 +1003,7 @@ "arn":{"shape":"RoomArn"}, "createTime":{"shape":"Time"}, "id":{"shape":"RoomID"}, + "loggingConfigurationIdentifiers":{"shape":"LoggingConfigurationIdentifierList"}, "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, "messageReviewHandler":{"shape":"MessageReviewHandler"}, diff --git a/models/apis/ivschat/2020-07-14/docs-2.json b/models/apis/ivschat/2020-07-14/docs-2.json index f22a6a0f118..1c66dc065bb 100644 --- a/models/apis/ivschat/2020-07-14/docs-2.json +++ b/models/apis/ivschat/2020-07-14/docs-2.json @@ -1,18 +1,23 @@ { "version": "2.0", - "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resource is part of Amazon IVS Chat:
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Messaging Endpoints
DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Chat Token Endpoint
CreateChatToken — Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.
Room Endpoints
CreateRoom — Creates a room that allows clients to connect and pass messages.
DeleteRoom — Deletes the specified room.
GetRoom — Gets the specified room.
ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.
UpdateRoom — Updates a room’s configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
", + "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resources are part of Amazon IVS Chat:
LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Messaging Endpoints
DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Chat Token Endpoint
CreateChatToken — Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Room Endpoints
CreateRoom — Creates a room that allows clients to connect and pass messages.
DeleteRoom — Deletes the specified room.
GetRoom — Gets the specified room.
ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.
UpdateRoom — Updates a room’s configuration.
Logging Configuration Endpoints
CreateLoggingConfiguration — Creates a logging configuration that allows clients to store and record sent messages.
DeleteLoggingConfiguration — Deletes the specified logging configuration.
GetLoggingConfiguration — Gets the specified logging configuration.
ListLoggingConfigurations — Gets summary information about all your logging configurations in the AWS region where the API request is processed.
UpdateLoggingConfiguration — Updates a specified logging configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
", "operations": { - "CreateChatToken": "Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
", + "CreateChatToken": "Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities field to permit an end user to send messages or moderate a room.
The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
", + "CreateLoggingConfiguration": "Creates a logging configuration that allows clients to store and record sent messages.
", "CreateRoom": "Creates a room that allows clients to connect and pass messages.
", + "DeleteLoggingConfiguration": "Deletes the specified logging configuration.
", "DeleteMessage": "Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
Deletes the specified room.
", "DisconnectUser": "Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
", + "GetLoggingConfiguration": "Gets the specified logging configuration.
", "GetRoom": "Gets the specified room.
", + "ListLoggingConfigurations": "Gets summary information about all your logging configurations in the AWS region where the API request is processed.
", "ListRooms": "Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.
Gets information about AWS tags for the specified ARN.
", "SendEvent": "Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
", "TagResource": "Adds or updates tags for the AWS resource with the specified ARN.
", "UntagResource": "Removes tags from the resource with the specified ARN.
", + "UpdateLoggingConfiguration": "Updates a specified logging configuration.
", "UpdateRoom": "Updates a room’s configuration.
" }, "shapes": { @@ -21,6 +26,12 @@ "refs": { } }, + "BucketName": { + "base": null, + "refs": { + "S3DestinationConfiguration$bucketName": "Name of the Amazon S3 bucket where chat activity will be logged.
" + } + }, "ChatToken": { "base": null, "refs": { @@ -45,6 +56,12 @@ "ChatTokenCapabilities$member": null } }, + "CloudWatchLogsDestinationConfiguration": { + "base": "Specifies a CloudWatch Logs location where chat logs will be stored.
", + "refs": { + "DestinationConfiguration$cloudWatchLogs": "Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
" + } + }, "ConflictException": { "base": "", "refs": { @@ -60,6 +77,22 @@ "refs": { } }, + "CreateLoggingConfigurationRequest": { + "base": null, + "refs": { + } + }, + "CreateLoggingConfigurationResponse": { + "base": null, + "refs": { + } + }, + "CreateLoggingConfigurationState": { + "base": null, + "refs": { + "CreateLoggingConfigurationResponse$state": "The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
" + } + }, + "DestinationConfiguration": { + "base": "A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).
", + "refs": { + "CreateLoggingConfigurationRequest$destinationConfiguration": "A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
A complex type that contains a destination configuration for where chat content will be logged. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
A complex type that contains a destination configuration for where chat content will be logged.
", + "UpdateLoggingConfigurationRequest$destinationConfiguration": "A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
Name of the field which failed validation.
" } }, + "FirehoseDestinationConfiguration": { + "base": "Specifies a Kinesis Firehose location where chat logs will be stored.
", + "refs": { + "DestinationConfiguration$firehose": "Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
" + } + }, + "GetLoggingConfigurationRequest": { + "base": null, + "refs": { + } + }, + "GetLoggingConfigurationResponse": { + "base": null, + "refs": { + } + }, "GetRoomRequest": { "base": null, "refs": { @@ -169,6 +240,16 @@ "ThrottlingException$limit": "" } }, + "ListLoggingConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "ListLoggingConfigurationsResponse": { + "base": null, + "refs": { + } + }, "ListRoomsRequest": { "base": null, "refs": { @@ -189,6 +270,87 @@ "refs": { } }, + "LogGroupName": { + "base": null, + "refs": { + "CloudWatchLogsDestinationConfiguration$logGroupName": "Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
" + } + }, + "LoggingConfigurationArn": { + "base": null, + "refs": { + "CreateLoggingConfigurationResponse$arn": "Logging-configuration ARN, assigned by the system.
", + "GetLoggingConfigurationResponse$arn": "Logging-configuration ARN, from the request (if identifier was an ARN).
Logging-configuration ARN.
", + "UpdateLoggingConfigurationResponse$arn": "Logging-configuration ARN, from the request (if identifier was an ARN).
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
", + "GetLoggingConfigurationResponse$id": "Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
", + "LoggingConfigurationSummary$id": "Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
", + "UpdateLoggingConfigurationResponse$id": "Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + } + }, + "LoggingConfigurationIdentifier": { + "base": null, + "refs": { + "DeleteLoggingConfigurationRequest$identifier": "Identifier of the logging configuration to be deleted.
", + "GetLoggingConfigurationRequest$identifier": "Identifier of the logging configuration to be retrieved.
", + "ListRoomsRequest$loggingConfigurationIdentifier": "Logging-configuration identifier.
", + "LoggingConfigurationIdentifierList$member": null, + "UpdateLoggingConfigurationRequest$identifier": "Identifier of the logging configuration to be updated.
" + } + }, + "LoggingConfigurationIdentifierList": { + "base": null, + "refs": { + "CreateRoomRequest$loggingConfigurationIdentifiers": "Array of logging-configuration identifiers attached to the room.
", + "CreateRoomResponse$loggingConfigurationIdentifiers": "Array of logging configurations attached to the room, from the request (if specified).
", + "GetRoomResponse$loggingConfigurationIdentifiers": "Array of logging configurations attached to the room.
", + "RoomSummary$loggingConfigurationIdentifiers": "List of logging-configuration identifiers attached to the room.
", + "UpdateRoomRequest$loggingConfigurationIdentifiers": "Array of logging-configuration identifiers attached to the room.
", + "UpdateRoomResponse$loggingConfigurationIdentifiers": "Array of logging configurations attached to the room, from the request (if specified).
" + } + }, + "LoggingConfigurationList": { + "base": null, + "refs": { + "ListLoggingConfigurationsResponse$loggingConfigurations": "List of the matching logging configurations (summary information only). There is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
Logging-configuration name. The value does not need to be unique.
", + "CreateLoggingConfigurationResponse$name": "Logging-configuration name, from the request (if specified).
", + "GetLoggingConfigurationResponse$name": "Logging-configuration name. This value does not need to be unique.
", + "LoggingConfigurationSummary$name": "Logging-configuration name. The value does not need to be unique.
", + "UpdateLoggingConfigurationRequest$name": "Logging-configuration name. The value does not need to be unique.
", + "UpdateLoggingConfigurationResponse$name": "Logging-configuration name, from the request (if specified).
" + } + }, + "LoggingConfigurationState": { + "base": null, + "refs": { + "GetLoggingConfigurationResponse$state": "The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging chat content.
Summary information about a logging configuration.
", + "refs": { + "LoggingConfigurationList$member": null + } + }, + "MaxLoggingConfigurationResults": { + "base": null, + "refs": { + "ListLoggingConfigurationsRequest$maxResults": "Maximum number of logging configurations to return. Default: 50.
" + } + }, "MaxRoomResults": { "base": null, "refs": { @@ -215,6 +377,8 @@ "PaginationToken": { "base": null, "refs": { + "ListLoggingConfigurationsRequest$nextToken": "The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.
If there are more logging configurations than maxResults, use nextToken in the request to get the next set.
The first room to retrieve. This is used for pagination; see the nextToken response field.
If there are more rooms than maxResults, use nextToken in the request to get the next set.
Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
", - "CreateRoomResponse$maximumMessageLength": "Maximum number of characters in a single message, from the request.
", + "CreateRoomResponse$maximumMessageLength": "Maximum number of characters in a single message, from the request (if specified).
", "GetRoomResponse$maximumMessageLength": "Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
", "UpdateRoomRequest$maximumMessageLength": "The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
", - "UpdateRoomResponse$maximumMessageLength": "Maximum number of characters in a single message, from the request.
" + "UpdateRoomResponse$maximumMessageLength": "Maximum number of characters in a single message, from the request (if specified).
" } }, "RoomMaxMessageRatePerSecond": { "base": null, "refs": { "CreateRoomRequest$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
", - "CreateRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients), from the request.
", + "CreateRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
", "GetRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
", "UpdateRoomRequest$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
", - "UpdateRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients), from the request.
" + "UpdateRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
" } }, "RoomName": { @@ -327,7 +491,7 @@ "ListRoomsRequest$name": "Filters the list to match the specified room name.
", "RoomSummary$name": "Room name. The value does not need to be unique.
", "UpdateRoomRequest$name": "Room name. The value does not need to be unique.
", - "UpdateRoomResponse$name": "Room name, from the request.
" + "UpdateRoomResponse$name": "Room name, from the request (if specified).
" } }, "RoomSummary": { @@ -336,6 +500,12 @@ "RoomList$member": null } }, + "S3DestinationConfiguration": { + "base": "Specifies an S3 location where chat logs will be stored.
", + "refs": { + "DestinationConfiguration$s3": "Name of the Amazon S3 bucket where chat activity will be logged.
" + } + }, "SendEventRequest": { "base": null, "refs": { @@ -376,7 +546,7 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceRequest$tagKeys": "Array of tags to be removed. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
" + "UntagResourceRequest$tagKeys": "Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented there.
Tags attached to the resource, from the request (if specified). Array of maps, each of the form string:string (key:value).
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Tags attached to the resource, from the request.
", + "CreateRoomResponse$tags": "Tags attached to the resource, from the request (if specified).
", + "GetLoggingConfigurationResponse$tags": "Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource, from the request.
", - "RoomSummary$tags": "Tags attached to the resource. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
", - "TagResourceRequest$tags": "Array of tags to be added or updated. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
", - "UpdateRoomResponse$tags": "Tags attached to the resource.
" + "ListTagsForResourceResponse$tags": "Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateChatTokenResponse$tokenExpirationTime": "Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "CreateLoggingConfigurationResponse$createTime": "Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "CreateLoggingConfigurationResponse$updateTime": "Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CreateRoomResponse$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "GetLoggingConfigurationResponse$createTime": "Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "GetLoggingConfigurationResponse$updateTime": "Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", "GetRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", "GetRoomResponse$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "LoggingConfigurationSummary$createTime": "Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "LoggingConfigurationSummary$updateTime": "Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", "RoomSummary$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", "RoomSummary$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "UpdateLoggingConfigurationResponse$createTime": "Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "UpdateLoggingConfigurationResponse$updateTime": "Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", "UpdateRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", "UpdateRoomResponse$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" } @@ -437,6 +620,22 @@ "refs": { } }, + "UpdateLoggingConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UpdateLoggingConfigurationResponse": { + "base": null, + "refs": { + } + }, + "UpdateLoggingConfigurationState": { + "base": null, + "refs": { + "UpdateLoggingConfigurationResponse$state": "The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
", "AddPermission": "Grants an Amazon Web Services service, account, or organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
", "CreateAlias": "Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).
", + "CreateCodeSigningConfig": "Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).
", "CreateEventSourceMapping": "Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.
For details about how to configure different event sources, see the following topics.
The following error handling options are available only for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor - Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
", "CreateFunction": "Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, the default value is x86-64.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function.
If another account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
", "CreateFunctionUrlConfig": "Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.
", @@ -581,7 +581,7 @@ "EnvironmentResponse": { "base": "The results of an operation to update or read environment variables. If the operation is successful, the response contains the environment variables. If it failed, the response contains details about the error.
", "refs": { - "FunctionConfiguration$Environment": "The function's environment variables.
" + "FunctionConfiguration$Environment": "The function's environment variables. Omitted from CloudTrail logs.
" } }, "EnvironmentVariableName": { @@ -600,7 +600,7 @@ "base": null, "refs": { "Environment$Variables": "Environment variable key-value pairs. For more information, see Using Lambda environment variables.
", - "EnvironmentResponse$Variables": "Environment variable key-value pairs.
" + "EnvironmentResponse$Variables": "Environment variable key-value pairs. Omitted from CloudTrail logs.
" } }, "EphemeralStorage": { @@ -1453,9 +1453,9 @@ "MaximumBatchingWindowInSeconds": { "base": null, "refs": { - "CreateEventSourceMappingRequest$MaximumBatchingWindowInSeconds": "(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The amount of provisioned concurrency available.
", - "GetProvisionedConcurrencyConfigResponse$AllocatedProvisionedConcurrentExecutions": "The amount of provisioned concurrency allocated.
", + "GetProvisionedConcurrencyConfigResponse$AllocatedProvisionedConcurrentExecutions": "The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
", "ProvisionedConcurrencyConfigListItem$AvailableProvisionedConcurrentExecutions": "The amount of provisioned concurrency available.
", - "ProvisionedConcurrencyConfigListItem$AllocatedProvisionedConcurrentExecutions": "The amount of provisioned concurrency allocated.
", + "ProvisionedConcurrencyConfigListItem$AllocatedProvisionedConcurrentExecutions": "The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
", "PutProvisionedConcurrencyConfigResponse$AvailableProvisionedConcurrentExecutions": "The amount of provisioned concurrency available.
", - "PutProvisionedConcurrencyConfigResponse$AllocatedProvisionedConcurrentExecutions": "The amount of provisioned concurrency allocated.
" + "PutProvisionedConcurrencyConfigResponse$AllocatedProvisionedConcurrentExecutions": "The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
" } }, "OnFailure": { @@ -1871,7 +1871,7 @@ "SourceAccessType": { "base": null, "refs": { - "SourceAccessConfiguration$Type": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".
BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
VPC_SECURITY_GROUP - The VPC security group used to manage access to your self-managed Apache Kafka brokers.
SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
VIRTUAL_HOST - (Amazon MQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
CLIENT_CERTIFICATE_TLS_AUTH - (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
SERVER_ROOT_CA_CERTIFICATE - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".
BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
VPC_SUBNET - (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
VPC_SECURITY_GROUP - (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
SASL_SCRAM_256_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH - (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
VIRTUAL_HOST - (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
CLIENT_CERTIFICATE_TLS_AUTH - (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
SERVER_ROOT_CA_CERTIFICATE - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see services-msk-consumer-group-id.
", - "SelfManagedKafkaEventSourceConfig$ConsumerGroupId": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see services-msk-consumer-group-id.
", + "AmazonManagedKafkaEventSourceConfig$ConsumerGroupId": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
", + "SelfManagedKafkaEventSourceConfig$ConsumerGroupId": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
", "SourceAccessConfiguration$URI": "The value for your chosen configuration in Type. For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
Status
A dataset import job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
", "CreateEventTracker": "Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.
When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.
The event tracker must be in the ACTIVE state before using the tracking ID.
Related APIs
", "CreateFilter": "Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
", + "CreateMetricAttribution": "Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
", "CreateRecommender": "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
", "CreateSchema": "Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
", "CreateSolution": "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
", @@ -20,6 +21,7 @@ "DeleteDatasetGroup": "Deletes a dataset group. Before you delete a dataset group, you must delete the following:
All associated event trackers.
All associated solutions.
All datasets in the dataset group.
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
", "DeleteFilter": "Deletes a filter.
", + "DeleteMetricAttribution": "Deletes a metric attribution.
", "DeleteRecommender": "Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
", "DeleteSchema": "Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
", "DeleteSolution": "Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
Describes the given feature transformation.
", "DescribeFilter": "Describes a filter's properties.
", + "DescribeMetricAttribution": "Describes a metric attribution.
", "DescribeRecipe": "Describes a recipe.
A recipe contains three items:
An algorithm that trains a model.
Hyperparameters that govern the training.
Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
Describes the given recommender, including its status.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
The modelMetrics key is null when the recommender is being created or deleted.
For more information on recommenders, see CreateRecommender.
", "DescribeSchema": "Describes a schema. For more information on schemas, see CreateSchema.
", @@ -49,6 +52,8 @@ "ListDatasets": "Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
", "ListEventTrackers": "Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
", "ListFilters": "Lists all filters that belong to a given dataset group.
", + "ListMetricAttributionMetrics": "Lists the metrics for the metric attribution.
", + "ListMetricAttributions": "Lists metric attributions.
", "ListRecipes": "Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
", "ListRecommenders": "Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
", "ListSchemas": "Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
", @@ -61,6 +66,7 @@ "TagResource": "Add a list of tags to a resource.
", "UntagResource": "Remove tags that are attached to a resource.
", "UpdateCampaign": "Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.
For more information on campaigns, see CreateCampaign.
", + "UpdateMetricAttribution": "Updates a metric attribution.
", "UpdateRecommender": "Updates the recommender to modify the recommender configuration.
" }, "shapes": { @@ -123,6 +129,8 @@ "CreateEventTrackerResponse$eventTrackerArn": "The ARN of the event tracker.
", "CreateFilterRequest$datasetGroupArn": "The ARN of the dataset group that the filter will belong to.
", "CreateFilterResponse$filterArn": "The ARN of the new filter.
", + "CreateMetricAttributionRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
", + "CreateMetricAttributionResponse$metricAttributionArn": "The Amazon Resource Name (ARN) for the new metric attribution.
", "CreateRecommenderRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
", "CreateRecommenderRequest$recipeArn": "The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
", "CreateRecommenderResponse$recommenderArn": "The Amazon Resource Name (ARN) of the recommender.
", @@ -153,6 +161,7 @@ "DeleteDatasetRequest$datasetArn": "The Amazon Resource Name (ARN) of the dataset to delete.
", "DeleteEventTrackerRequest$eventTrackerArn": "The Amazon Resource Name (ARN) of the event tracker to delete.
", "DeleteFilterRequest$filterArn": "The ARN of the filter to delete.
", + "DeleteMetricAttributionRequest$metricAttributionArn": "The metric attribution's Amazon Resource Name (ARN).
", "DeleteRecommenderRequest$recommenderArn": "The Amazon Resource Name (ARN) of the recommender to delete.
", "DeleteSchemaRequest$schemaArn": "The Amazon Resource Name (ARN) of the schema to delete.
", "DeleteSolutionRequest$solutionArn": "The ARN of the solution to delete.
", @@ -167,6 +176,7 @@ "DescribeEventTrackerRequest$eventTrackerArn": "The Amazon Resource Name (ARN) of the event tracker to describe.
", "DescribeFeatureTransformationRequest$featureTransformationArn": "The Amazon Resource Name (ARN) of the feature transformation to describe.
", "DescribeFilterRequest$filterArn": "The ARN of the filter to describe.
", + "DescribeMetricAttributionRequest$metricAttributionArn": "The metric attribution's Amazon Resource Name (ARN).
", "DescribeRecipeRequest$recipeArn": "The Amazon Resource Name (ARN) of the recipe to describe.
", "DescribeRecommenderRequest$recommenderArn": "The Amazon Resource Name (ARN) of the recommender to describe.
", "DescribeSchemaRequest$schemaArn": "The Amazon Resource Name (ARN) of the schema to retrieve.
", @@ -190,10 +200,15 @@ "ListDatasetsRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
", "ListEventTrackersRequest$datasetGroupArn": "The ARN of a dataset group used to filter the response.
", "ListFiltersRequest$datasetGroupArn": "The ARN of the dataset group that contains the filters.
", + "ListMetricAttributionMetricsRequest$metricAttributionArn": "The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.
", + "ListMetricAttributionsRequest$datasetGroupArn": "The metric attributions' dataset group Amazon Resource Name (ARN).
", "ListRecommendersRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
", "ListSolutionVersionsRequest$solutionArn": "The Amazon Resource Name (ARN) of the solution.
", "ListSolutionsRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group.
", "ListTagsForResourceRequest$resourceArn": "The resource's Amazon Resource Name.
", + "MetricAttribution$metricAttributionArn": "The metric attribution's Amazon Resource Name (ARN).
", + "MetricAttribution$datasetGroupArn": "The metric attribution's dataset group Amazon Resource Name (ARN).
", + "MetricAttributionSummary$metricAttributionArn": "The metric attribution's Amazon Resource Name (ARN).
", "Recipe$recipeArn": "The Amazon Resource Name (ARN) of the recipe.
", "Recipe$algorithmArn": "The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
", "Recipe$featureTransformationArn": "The ARN of the FeatureTransformation object.
", @@ -208,6 +223,7 @@ "Solution$recipeArn": "The ARN of the recipe used to create the solution.
", "Solution$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group that provides the training data.
", "SolutionSummary$solutionArn": "The Amazon Resource Name (ARN) of the solution.
", + "SolutionSummary$recipeArn": "The Amazon Resource Name (ARN) of the recipe used by the solution.
", "SolutionVersion$solutionVersionArn": "The ARN of the solution version.
", "SolutionVersion$solutionArn": "The ARN of the solution.
", "SolutionVersion$recipeArn": "The ARN of the recipe used in the solution.
", @@ -223,6 +239,8 @@ "UpdateCampaignRequest$campaignArn": "The Amazon Resource Name (ARN) of the campaign.
", "UpdateCampaignRequest$solutionVersionArn": "The ARN of a new solution version to deploy.
", "UpdateCampaignResponse$campaignArn": "The same campaign ARN as given in the request.
", + "UpdateMetricAttributionRequest$metricAttributionArn": "The Amazon Resource Name (ARN) for the metric attribution to update.
", + "UpdateMetricAttributionResponse$metricAttributionArn": "The Amazon Resource Name (ARN) for the metric attribution that you updated.
", "UpdateRecommenderRequest$recommenderArn": "The Amazon Resource Name (ARN) of the recommender to modify.
", "UpdateRecommenderResponse$recommenderArn": "The same recommender Amazon Resource Name (ARN) as given in the request.
" } @@ -326,7 +344,9 @@ "Boolean": { "base": null, "refs": { - "CreateSolutionRequest$performHPO": "Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.
When performing AutoML, this parameter is always true and you should not set it to false.
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
", + "CreateSolutionRequest$performHPO": "Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.
When performing AutoML, this parameter is always true and you should not set it to false.
Whether the job publishes metrics to Amazon S3 for a metric attribution.
" } }, "Campaign": { @@ -503,6 +523,16 @@ "refs": { } }, + "CreateMetricAttributionRequest": { + "base": null, + "refs": { + } + }, + "CreateMetricAttributionResponse": { + "base": null, + "refs": { + } + }, "CreateRecommenderRequest": { "base": null, "refs": { @@ -698,6 +728,10 @@ "Filter$lastUpdatedDateTime": "The time at which the filter was last updated.
", "FilterSummary$creationDateTime": "The time at which the filter was created.
", "FilterSummary$lastUpdatedDateTime": "The time at which the filter was last updated.
", + "MetricAttribution$creationDateTime": "The metric attribution's creation date time.
", + "MetricAttribution$lastUpdatedDateTime": "The metric attribution's last updated date time.
", + "MetricAttributionSummary$creationDateTime": "The metric attribution's creation date time.
", + "MetricAttributionSummary$lastUpdatedDateTime": "The metric attribution's last updated date time.
", "Recipe$creationDateTime": "The date and time (in Unix format) that the recipe was created.
", "Recipe$lastUpdatedDateTime": "The date and time (in Unix format) that the recipe was last updated.
", "RecipeSummary$creationDateTime": "The date and time (in Unix time) that the recipe was created.
", @@ -785,6 +819,11 @@ "refs": { } }, + "DeleteMetricAttributionRequest": { + "base": null, + "refs": { + } + }, "DeleteRecommenderRequest": { "base": null, "refs": { @@ -910,6 +949,16 @@ "refs": { } }, + "DescribeMetricAttributionRequest": { + "base": null, + "refs": { + } + }, + "DescribeMetricAttributionResponse": { + "base": null, + "refs": { + } + }, "DescribeRecipeRequest": { "base": null, "refs": { @@ -1021,6 +1070,7 @@ "base": null, "refs": { "CreateSolutionRequest$eventType": "When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.
If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
The metric's event type.
", "Solution$eventType": "The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
The event type (for example, 'click' or 'like') that is used for training the model.
" } @@ -1049,6 +1099,8 @@ "DatasetImportJobSummary$failureReason": "If a dataset import job fails, the reason behind the failure.
", "Filter$failureReason": "If the filter failed, the reason for its failure.
", "FilterSummary$failureReason": "If the filter failed, the reason for the failure.
", + "MetricAttribution$failureReason": "The metric attribution's failure reason.
", + "MetricAttributionSummary$failureReason": "The metric attribution's failure reason.
", "Recommender$failureReason": "If a recommender fails, the reason behind the failure.
", "RecommenderUpdateSummary$failureReason": "If a recommender update fails, the reason behind the failure.
", "SolutionVersion$failureReason": "If training a solution version fails, the reason for the failure.
", @@ -1316,6 +1368,26 @@ "refs": { } }, + "ListMetricAttributionMetricsRequest": { + "base": null, + "refs": { + } + }, + "ListMetricAttributionMetricsResponse": { + "base": null, + "refs": { + } + }, + "ListMetricAttributionsRequest": { + "base": null, + "refs": { + } + }, + "ListMetricAttributionsResponse": { + "base": null, + "refs": { + } + }, "ListRecipesRequest": { "base": null, "refs": { @@ -1388,6 +1460,8 @@ "ListDatasetsRequest$maxResults": "The maximum number of datasets to return.
", "ListEventTrackersRequest$maxResults": "The maximum number of event trackers to return.
", "ListFiltersRequest$maxResults": "The maximum number of filters to return.
", + "ListMetricAttributionMetricsRequest$maxResults": "The maximum number of metrics to return in one page of results.
", + "ListMetricAttributionsRequest$maxResults": "The maximum number of metric attributions to return in one page of results.
", "ListRecipesRequest$maxResults": "The maximum number of recipes to return.
", "ListRecommendersRequest$maxResults": "The maximum number of recommenders to return.
", "ListSchemasRequest$maxResults": "The maximum number of schemas to return.
", @@ -1395,11 +1469,65 @@ "ListSolutionsRequest$maxResults": "The maximum number of solutions to return.
" } }, + "MetricAttribute": { + "base": "Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.
", + "refs": { + "MetricAttributes$member": null + } + }, + "MetricAttributes": { + "base": null, + "refs": { + "CreateMetricAttributionRequest$metrics": "A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
The metrics for the specified metric attribution.
", + "UpdateMetricAttributionRequest$addMetrics": "Add new metric attributes to the metric attribution.
" + } + }, + "MetricAttributesNamesList": { + "base": null, + "refs": { + "UpdateMetricAttributionRequest$removeMetrics": "Remove metric attributes from the metric attribution.
" + } + }, + "MetricAttribution": { + "base": "Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
", + "refs": { + "DescribeMetricAttributionResponse$metricAttribution": "The details of the metric attribution.
" + } + }, + "MetricAttributionOutput": { + "base": "The output configuration details for a metric attribution.
", + "refs": { + "CreateMetricAttributionRequest$metricsOutputConfig": "The output configuration details for the metric attribution.
", + "MetricAttribution$metricsOutputConfig": "The metric attribution's output configuration.
", + "UpdateMetricAttributionRequest$metricsOutputConfig": "An output config for the metric attribution.
" + } + }, + "MetricAttributionSummary": { + "base": "Provides a summary of the properties of a metric attribution. For a complete listing, call the DescribeMetricAttribution.
", + "refs": { + "MetricAttributions$member": null + } + }, + "MetricAttributions": { + "base": null, + "refs": { + "ListMetricAttributionsResponse$metricAttributions": "The list of metric attributions.
" + } + }, + "MetricExpression": { + "base": null, + "refs": { + "MetricAttribute$expression": "The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
The metric to optimize.
", "HPOObjective$metricName": "The name of the metric.
", + "MetricAttribute$metricName": "The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
", + "MetricAttributesNamesList$member": null, "Metrics$key": null } }, @@ -1442,9 +1570,11 @@ "CreateDatasetRequest$name": "The name for the dataset.
", "CreateEventTrackerRequest$name": "The name for the event tracker.
", "CreateFilterRequest$name": "The name of the filter to create.
", + "CreateMetricAttributionRequest$name": "A name for the metric attribution.
", "CreateRecommenderRequest$name": "The name of the recommender.
", "CreateSchemaRequest$name": "The name for the schema.
", "CreateSolutionRequest$name": "The name for the solution.
", + "CreateSolutionVersionRequest$name": "The name of the solution version.
", "Dataset$name": "The name of the dataset.
", "DatasetExportJob$jobName": "The name of the export job.
", "DatasetExportJobSummary$jobName": "The name of the dataset export job.
", @@ -1460,12 +1590,15 @@ "FeatureTransformation$name": "The name of the feature transformation.
", "Filter$name": "The name of the filter.
", "FilterSummary$name": "The name of the filter.
", + "MetricAttribution$name": "The metric attribution's name.
", + "MetricAttributionSummary$name": "The name of the metric attribution.
", "Recipe$name": "The name of the recipe.
", "RecipeSummary$name": "The name of the recipe.
", "Recommender$name": "The name of the recommender.
", "RecommenderSummary$name": "The name of the recommender.
", "Solution$name": "The name of the solution.
", - "SolutionSummary$name": "The name of the solution.
" + "SolutionSummary$name": "The name of the solution.
", + "SolutionVersion$name": "The name of the solution version.
" } }, "NextToken": { @@ -1489,6 +1622,10 @@ "ListEventTrackersResponse$nextToken": "A token for getting the next set of event trackers (if they exist).
", "ListFiltersRequest$nextToken": "A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).
A token for getting the next set of filters (if they exist).
", + "ListMetricAttributionMetricsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListMetricAttributionMetricsResponse$nextToken": "Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.
Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListMetricAttributionsResponse$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListRecipesRequest$nextToken": "A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
A token for getting the next set of recipes.
", "ListRecommendersRequest$nextToken": "A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
", "CreateDatasetGroupRequest$roleArn": "The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
", "CreateDatasetImportJobRequest$roleArn": "The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
", - "DatasetGroup$roleArn": "The ARN of the IAM role that has permissions to create the dataset group.
" + "DatasetGroup$roleArn": "The ARN of the IAM role that has permissions to create the dataset group.
", + "MetricAttributionOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
" } }, "S3DataConfig": { @@ -1666,7 +1804,8 @@ "BatchInferenceJobOutput$s3DataDestination": "Information on the Amazon S3 bucket in which the batch inference job's output is stored.
", "BatchSegmentJobInput$s3DataSource": null, "BatchSegmentJobOutput$s3DataDestination": null, - "DatasetExportJobOutput$s3DataDestination": null + "DatasetExportJobOutput$s3DataDestination": null, + "MetricAttributionOutput$s3DataDestination": null } }, "S3Location": { @@ -1760,6 +1899,8 @@ "FeatureTransformation$status": "The status of the feature transformation.
A feature transformation can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
The status of the filter.
", "FilterSummary$status": "The status of the filter.
", + "MetricAttribution$status": "The metric attribution's status.
", + "MetricAttributionSummary$status": "The metric attribution's status.
", "Recipe$status": "The status of the recipe.
", "RecipeSummary$status": "The status of the recipe.
", "Recommender$status": "The status of the recommender.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.
<p>You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.</p> With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.
You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.
", "operations": { - "BatchCreateRumMetricDefinitions": "Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.
By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.
If you also send extended metrics, you can send metrics to Evidently as well as CloudWatch, and you can also optionally send the metrics with additional dimensions. The valid dimension names for the additional dimensions are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.
<p>The maximum number of metric definitions that one destination can contain is 2000.</p> <p>Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p> <p>You must have already created a destination for the metrics before you send them. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p> <p>If some metric definitions specified in a <code>BatchCreateRumMetricDefinitions</code> operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.</p> Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.
By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.
If you also send extended metrics, you can send metrics to Evidently as well as CloudWatch, and you can also optionally send the metrics with additional dimensions. The valid dimension names for the additional dimensions are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.
You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.
If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
Removes the specified metrics from being sent to an extended metrics destination.
If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.
The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.
Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
", "CreateAppMonitor": "Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.
You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead.
After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?
", @@ -183,6 +183,20 @@ "refs": { } }, + "CustomEvents": { + "base": "A structure that contains information about custom events for this app monitor.
", + "refs": { + "AppMonitor$CustomEvents": "Specifies whether this app monitor allows the web client to define and send custom events.
For more information about custom events, see Send custom events.
", + "CreateAppMonitorRequest$CustomEvents": "Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.
For more information about custom events, see Send custom events.
", + "UpdateAppMonitorRequest$CustomEvents": "Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
For more information about custom events, see Send custom events.
" + } + }, + "CustomEventsStatus": { + "base": null, + "refs": { + "CustomEvents$Status": "Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.
", "refs": { @@ -237,7 +251,7 @@ "base": null, "refs": { "MetricDefinition$DimensionKeys": "This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
Use this field only if you are sending the metric to CloudWatch.
This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:
\"metadata.pageId\": \"PageId\"
\"metadata.browserName\": \"BrowserName\"
\"metadata.deviceType\": \"DeviceType\"
\"metadata.osName\": \"OSName\"
\"metadata.countryCode\": \"CountryCode\"
\"event_details.fileType\": \"FileType\"
<p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> Use this field only if you are sending the metric to CloudWatch.
This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:
\"metadata.pageId\": \"PageId\"
\"metadata.browserName\": \"BrowserName\"
\"metadata.deviceType\": \"DeviceType\"
\"metadata.osName\": \"OSName\"
\"metadata.countryCode\": \"CountryCode\"
\"event_details.fileType\": \"FileType\"
All dimensions listed in this field must also be included in EventPattern.
A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages and IncludedPages in the same operation.
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p> If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
You can't include both ExcludedPages and IncludedPages in the same operation.
The list of tag keys and values associated with this app monitor.
", - "CreateAppMonitorRequest$Tags": "Assigns one or more tags (key-value pairs) to the app monitor.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with an app monitor.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p> Assigns one or more tags (key-value pairs) to the app monitor.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an app monitor.
For more information, see Tagging Amazon Web Services resources.
", "ListTagsForResourceResponse$Tags": "The list of tag keys and values associated with the resource you specified.
", "TagResourceRequest$Tags": "The list of key-value pairs to associate with the resource.
" } diff --git a/models/apis/rum/2018-05-10/endpoint-tests-1.json b/models/apis/rum/2018-05-10/endpoint-tests-1.json index ba73cf6f16e..bf22fcfdf07 100644 --- a/models/apis/rum/2018-05-10/endpoint-tests-1.json +++ b/models/apis/rum/2018-05-10/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "Region": "eu-central-1" } }, { @@ -21,9 +21,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -34,9 +34,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "Region": "eu-central-1" } }, { @@ -47,9 +47,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -60,9 +60,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "Region": "us-west-2" } }, { @@ -73,9 +73,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -86,9 +86,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "Region": "us-west-2" } }, { @@ -99,9 +99,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -112,9 +112,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": true + "Region": "eu-north-1" } }, { @@ -125,9 +125,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": false + "Region": "eu-north-1" } }, { @@ -138,9 +138,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": true + "Region": "eu-north-1" } }, { @@ -151,9 +151,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": false + "Region": "eu-north-1" } }, { @@ -164,9 +164,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true + "Region": "eu-west-2" } }, { @@ -177,9 +177,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false + "Region": "eu-west-2" } }, { @@ -190,9 +190,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true + "Region": "eu-west-2" } }, { @@ -203,9 +203,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false + "Region": "eu-west-2" } }, { @@ -216,9 +216,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true + "Region": "eu-west-1" } }, { @@ -229,9 +229,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false + "Region": "eu-west-1" } }, { @@ -242,9 +242,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true + "Region": "eu-west-1" } }, { @@ -255,9 +255,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "Region": "eu-west-1" } }, { @@ -268,9 +268,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "Region": "ap-northeast-1" } }, { @@ -281,9 +281,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -294,9 +294,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "Region": "ap-northeast-1" } }, { @@ -307,9 +307,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -320,9 +320,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "Region": "ap-southeast-1" } }, { @@ -333,9 +333,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -346,9 +346,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "Region": "ap-southeast-1" } }, { @@ -359,9 +359,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -372,9 +372,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "Region": "ap-southeast-2" } }, { @@ -385,9 +385,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -398,9 +398,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "Region": "ap-southeast-2" } }, { @@ -411,9 +411,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -424,9 +424,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -437,9 +437,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -450,9 +450,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -463,9 +463,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -476,9 +476,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": true + "Region": "us-east-2" } }, { @@ -489,9 +489,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": false + "Region": "us-east-2" } }, { @@ -502,9 +502,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": true + "Region": "us-east-2" } }, { @@ -515,9 +515,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": false + "Region": "us-east-2" } }, { @@ -528,9 +528,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -540,9 +540,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -552,9 +552,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/models/apis/s3control/2018-08-20/api-2.json b/models/apis/s3control/2018-08-20/api-2.json index 5a0a34e7dc6..aa97c1e0286 100644 --- a/models/apis/s3control/2018-08-20/api-2.json +++ b/models/apis/s3control/2018-08-20/api-2.json @@ -1030,7 +1030,10 @@ "required":["BucketLevel"], "members":{ "ActivityMetrics":{"shape":"ActivityMetrics"}, - "BucketLevel":{"shape":"BucketLevel"} + "BucketLevel":{"shape":"BucketLevel"}, + "AdvancedCostOptimizationMetrics":{"shape":"AdvancedCostOptimizationMetrics"}, + "AdvancedDataProtectionMetrics":{"shape":"AdvancedDataProtectionMetrics"}, + "DetailedStatusCodesMetrics":{"shape":"DetailedStatusCodesMetrics"} } }, "ActivityMetrics":{ @@ -1039,6 +1042,18 @@ "IsEnabled":{"shape":"IsEnabled"} } }, + "AdvancedCostOptimizationMetrics":{ + "type":"structure", + "members":{ + "IsEnabled":{"shape":"IsEnabled"} + } + }, + "AdvancedDataProtectionMetrics":{ + "type":"structure", + "members":{ + "IsEnabled":{"shape":"IsEnabled"} + } + }, "Alias":{ "type":"string", "max":63, @@ -1143,7 +1158,10 @@ "type":"structure", "members":{ "ActivityMetrics":{"shape":"ActivityMetrics"}, - "PrefixLevel":{"shape":"PrefixLevel"} + "PrefixLevel":{"shape":"PrefixLevel"}, + "AdvancedCostOptimizationMetrics":{"shape":"AdvancedCostOptimizationMetrics"}, + "AdvancedDataProtectionMetrics":{"shape":"AdvancedDataProtectionMetrics"}, + "DetailedStatusCodesMetrics":{"shape":"DetailedStatusCodesMetrics"} } }, "BucketLocationConstraint":{ @@ -1776,6 +1794,12 @@ "AsyncOperation":{"shape":"AsyncOperation"} } }, + "DetailedStatusCodesMetrics":{ + "type":"structure", + "members":{ + "IsEnabled":{"shape":"IsEnabled"} + } + }, "Endpoints":{ "type":"map", "key":{"shape":"NonEmptyMaxLength64String"}, diff --git a/models/apis/s3control/2018-08-20/docs-2.json b/models/apis/s3control/2018-08-20/docs-2.json index 82f347d1fca..68beca21b6c 100644 --- a/models/apis/s3control/2018-08-20/docs-2.json +++ b/models/apis/s3control/2018-08-20/docs-2.json @@ -39,7 +39,7 @@ "GetMultiRegionAccessPointPolicy": "Returns the access control policy of the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPointPolicy:
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPointPolicyStatus:
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.
Related actions include:
", - "GetStorageLensConfiguration": "Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.
The following actions are related to ListAccessPointsForObjectLambda:
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
A few things to consider about using tags:
Amazon S3 limits the maximum number of tags to 50 tags per job.
You can associate up to 50 tags with a job as long as they have unique tag keys.
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
The key and values are case sensitive.
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
To use this action, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
", "PutMultiRegionAccessPointPolicy": "Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to PutMultiRegionAccessPointPolicy:
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.
Related actions include:
", - "PutStorageLensConfiguration": "Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
", "UpdateJobStatus": "Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
" @@ -162,16 +162,30 @@ } }, "AccountLevel": { - "base": "A container for the account level Amazon S3 Storage Lens configuration.
", + "base": "A container for the account-level Amazon S3 Storage Lens configuration.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
", "refs": { "StorageLensConfiguration$AccountLevel": "A container for all the account-level configurations of your S3 Storage Lens configuration.
" } }, "ActivityMetrics": { - "base": "A container for the activity metrics.
", + "base": "The container element for Amazon S3 Storage Lens activity metrics. Activity metrics show details about how your storage is requested, such as requests (for example, All requests, Get requests, Put requests), bytes uploaded or downloaded, and errors.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
", "refs": { - "AccountLevel$ActivityMetrics": "A container for the S3 Storage Lens activity metrics.
", - "BucketLevel$ActivityMetrics": "A container for the bucket-level activity metrics for Amazon S3 Storage Lens
" + "AccountLevel$ActivityMetrics": "A container for S3 Storage Lens activity metrics.
", + "BucketLevel$ActivityMetrics": "A container for the bucket-level activity metrics for S3 Storage Lens.
" + } + }, + "AdvancedCostOptimizationMetrics": { + "base": "The container element for Amazon S3 Storage Lens advanced cost-optimization metrics. Advanced cost-optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
", + "refs": { + "AccountLevel$AdvancedCostOptimizationMetrics": "A container for S3 Storage Lens advanced cost-optimization metrics.
", + "BucketLevel$AdvancedCostOptimizationMetrics": "A container for bucket-level advanced cost-optimization metrics for S3 Storage Lens.
" + } + }, + "AdvancedDataProtectionMetrics": { + "base": "The container element for Amazon S3 Storage Lens advanced data-protection metrics. Advanced data-protection metrics provide insights that you can use to perform audits and protect your data, for example replication rule counts within and across Regions.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
", + "refs": { + "AccountLevel$AdvancedDataProtectionMetrics": "A container for S3 Storage Lens advanced data-protection metrics.
", + "BucketLevel$AdvancedDataProtectionMetrics": "A container for bucket-level advanced data-protection metrics for S3 Storage Lens.
" } }, "Alias": { @@ -288,7 +302,7 @@ } }, "BucketLevel": { - "base": "A container for the bucket-level configuration.
", + "base": "A container for the bucket-level configuration for Amazon S3 Storage Lens.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide.
", "refs": { "AccountLevel$BucketLevel": "A container for the S3 Storage Lens bucket-level configuration.
" } @@ -586,6 +600,13 @@ "refs": { } }, + "DetailedStatusCodesMetrics": { + "base": "The container element for Amazon S3 Storage Lens detailed status code metrics. Detailed status code metrics generate metrics for HTTP status codes, such as 200 OK, 403 Forbidden, 503 Service Unavailable and others.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
", + "refs": { + "AccountLevel$DetailedStatusCodesMetrics": "A container for detailed status code metrics.
", + "BucketLevel$DetailedStatusCodesMetrics": "A container for bucket-level detailed status code metrics for S3 Storage Lens.
" + } + }, "Endpoints": { "base": null, "refs": { @@ -918,8 +939,11 @@ "IsEnabled": { "base": null, "refs": { - "ActivityMetrics$IsEnabled": "A container for whether the activity metrics are enabled.
", + "ActivityMetrics$IsEnabled": "A container that indicates whether activity metrics are enabled.
", + "AdvancedCostOptimizationMetrics$IsEnabled": "A container that indicates whether advanced cost-optimization metrics are enabled.
", + "AdvancedDataProtectionMetrics$IsEnabled": "A container that indicates whether advanced data-protection metrics are enabled.
", "CloudWatchMetrics$IsEnabled": "A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.
A container that indicates whether detailed status code metrics are enabled.
", "ListStorageLensConfigurationEntry$IsEnabled": "A container for whether the S3 Storage Lens configuration is enabled. This property is required.
", "PrefixLevelStorageMetrics$IsEnabled": "A container for whether prefix-level storage metrics are enabled.
", "StorageLensConfiguration$IsEnabled": "A container for whether the S3 Storage Lens configuration is enabled.
" @@ -1668,7 +1692,7 @@ "PrefixLevel": { "base": "A container for the prefix-level configuration.
", "refs": { - "BucketLevel$PrefixLevel": "A container for the bucket-level prefix-level metrics for S3 Storage Lens
" + "BucketLevel$PrefixLevel": "A container for the prefix-level metrics for S3 Storage Lens.
" } }, "PrefixLevelStorageMetrics": { @@ -1684,7 +1708,7 @@ } }, "PublicAccessBlockConfiguration": { - "base": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon S3 User Guide.
This is not supported for Amazon S3 on Outposts.
", + "base": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon S3 User Guide.
This data type is not supported for Amazon S3 on Outposts.
", "refs": { "CreateAccessPointRequest$PublicAccessBlockConfiguration": " The PublicAccessBlock configuration that you want to apply to the access point.
The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
", "S3BucketDestination$Arn": "The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name
Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named \"destinationBucket\", set the TargetResource to \"arn:aws:s3:::destinationBucket\".
", + "S3CopyObjectOperation$TargetResource": "Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.
The source bucket used by the ManifestGenerator.
", "S3ManifestOutputLocation$Bucket": "The bucket ARN the generated manifest should be written to.
" } @@ -2081,9 +2105,9 @@ } }, "S3SetObjectAclOperation": { - "base": "Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations passes every object to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl.
", + "base": "Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations passes every object to the underlying PutObjectAcl API. For more information about the parameters for this operation, see PutObjectAcl .
Directs the specified job to run a PUT Object acl call on every object in the manifest.
" + "JobOperation$S3PutObjectAcl": "Directs the specified job to run a PutObjectAcl call on every object in the manifest.
A container for a key-value name pair.
", "refs": { "LifecycleRuleFilter$Tag": null, "S3TagSet$member": null @@ -2175,10 +2199,10 @@ "Setting": { "base": null, "refs": { - "PublicAccessBlockConfiguration$BlockPublicAcls": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
This is not supported for Amazon S3 on Outposts.
", - "PublicAccessBlockConfiguration$IgnorePublicAcls": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
This is not supported for Amazon S3 on Outposts.
", - "PublicAccessBlockConfiguration$BlockPublicPolicy": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
This is not supported for Amazon S3 on Outposts.
", - "PublicAccessBlockConfiguration$RestrictPublicBuckets": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This is not supported for Amazon S3 on Outposts.
" + "PublicAccessBlockConfiguration$BlockPublicAcls": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:
PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
This property is not supported for Amazon S3 on Outposts.
", + "PublicAccessBlockConfiguration$IgnorePublicAcls": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
This property is not supported for Amazon S3 on Outposts.
", + "PublicAccessBlockConfiguration$BlockPublicPolicy": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
This property is not supported for Amazon S3 on Outposts.
", + "PublicAccessBlockConfiguration$RestrictPublicBuckets": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Service principals and authorized users within this account.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This property is not supported for Amazon S3 on Outposts.
" } }, "StorageLensArn": { @@ -2267,14 +2291,14 @@ "TagKeyString": { "base": null, "refs": { - "S3Tag$Key": "", + "S3Tag$Key": "Key of the tag
", "StorageLensTag$Key": "" } }, "TagValueString": { "base": null, "refs": { - "S3Tag$Value": "", + "S3Tag$Value": "Value of the tag
", "StorageLensTag$Value": "" } }, diff --git a/models/apis/secretsmanager/2017-10-17/docs-2.json b/models/apis/secretsmanager/2017-10-17/docs-2.json index ffbc5f395b7..b94b62821a1 100644 --- a/models/apis/secretsmanager/2017-10-17/docs-2.json +++ b/models/apis/secretsmanager/2017-10-17/docs-2.json @@ -17,7 +17,7 @@ "RemoveRegionsFromReplication": "For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Replicates the secret to a new Regions. See Multi-Region secrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Configures and starts the asynchronous process of rotating the secret. For more information about rotation, see Rotate secrets.
If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the secret value is in the JSON structure of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser secret.
To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works.
You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose a template that matches your Rotation strategy.
When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.
Configures and starts the asynchronous process of rotating the secret. For more information about rotation, see Rotate secrets.
If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the secret value is in the JSON structure of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser secret.
To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works.
You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose a template that matches your Rotation strategy.
When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.
When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.
Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
You must call this operation from the Region in which you want to promote the replica to a primary secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both.
The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.
Specifies whether to overwrite a secret with the same name in the destination Region.
", - "DeleteSecretRequest$ForceDeleteWithoutRecovery": "Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.
", "PutResourcePolicyRequest$BlockPublicPolicy": "Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
", "ReplicateSecretToRegionsRequest$ForceOverwriteReplicaSecret": "Specifies whether to overwrite a secret with the same name in the destination Region.
", @@ -147,7 +147,7 @@ "DurationType": { "base": null, "refs": { - "RotationRulesType$Duration": "The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not go into the next UTC day. If you don't specify this value, the window automatically ends at the end of the UTC day. The window begins according to the ScheduleExpression. For more information, including examples, see Schedule expressions in Secrets Manager rotation.
The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.
A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.
Secrets Manager rate() expressions represent the interval in days that you want to rotate your secret, for example rate(10 days). If you use a rate() expression, the rotation window opens at midnight, and Secrets Manager rotates your secret any time that day after midnight. You can set a Duration to shorten the rotation window.
You can use a cron() expression to create rotation schedules that are more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation. If you use a cron() expression, Secrets Manager rotates your secret any time during that day after the window opens. For example, cron(0 8 1 * ? *) represents a rotation window that occurs on the first day of every month beginning at 8:00 AM UTC. Secrets Manager rotates the secret any time that day after 8:00 AM. You can set a Duration to shorten the rotation window.
A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.
Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.
Lists secrets in the requested order.
" + "ListSecretsRequest$SortOrder": "Secrets are listed by CreatedDate.
Details about a function's configuration.
", + "base": "Details about an Lambda function's configuration.
", "refs": { "ResourceDetails$AwsLambdaFunction": "Details about a Lambda function.
" } @@ -5376,6 +5376,7 @@ "AwsLambdaFunctionDetails$Role": "The function's execution role.
", "AwsLambdaFunctionDetails$Runtime": "The runtime environment for the Lambda function.
", "AwsLambdaFunctionDetails$Version": "The version of the Lambda function.
", + "AwsLambdaFunctionDetails$PackageType": "The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.
The error code.
", "AwsLambdaFunctionEnvironmentError$Message": "The error message.
", "AwsLambdaFunctionLayer$Arn": "The ARN of the function layer.
", @@ -5945,6 +5946,8 @@ "SoftwarePackage$FilePath": "The file system path to the package manager inventory file.
", "SoftwarePackage$FixedInVersion": "The version of the software package in which the vulnerability has been resolved.
", "SoftwarePackage$Remediation": "Describes the actions a customer can take to resolve the vulnerability in the software package.
", + "SoftwarePackage$SourceLayerHash": "The source layer hash of the vulnerable package.
", + "SoftwarePackage$SourceLayerArn": "The Amazon Resource Name (ARN) of the source layer.
", "SortCriterion$Field": "The finding attribute used to sort findings.
", "Standard$StandardsArn": "The ARN of a standard.
", "Standard$Name": "The name of the standard.
", @@ -6054,6 +6057,7 @@ "AwsElasticsearchDomainVPCOptions$AvailabilityZones": "The list of Availability Zones associated with the VPC subnets.
", "AwsElasticsearchDomainVPCOptions$SecurityGroupIds": "The list of security group IDs associated with the VPC endpoints for the domain.
", "AwsElasticsearchDomainVPCOptions$SubnetIds": "A list of subnet IDs associated with the VPC endpoints for the domain.
", + "AwsLambdaFunctionDetails$Architectures": "The instruction set architecture that the function uses. Valid values are x86_64 or arm64.
A list of VPC security groups IDs.
", "AwsLambdaFunctionVpcConfig$SubnetIds": "A list of VPC subnet IDs.
", "AwsLambdaLayerVersionDetails$CompatibleRuntimes": "The layer's compatible runtimes. Maximum number of five items.
Valid values: nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5 | provided
Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.
Gets the resource associated with the application.
", "GetAttributeGroup": "Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.
", + "GetConfiguration": " Retrieves a TagKey configuration from an account.
Retrieves a list of all of your applications. Results are paginated.
", "ListAssociatedAttributeGroups": "Lists all attribute groups that are associated with specified application. Results are paginated.
", - "ListAssociatedResources": "Lists all resources that are associated with specified application. Results are paginated.
", + "ListAssociatedResources": "Lists all of the resources that are associated with the specified application. Results are paginated.
If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.
Lists all attribute groups which you have access to. Results are paginated.
", "ListAttributeGroupsForApplication": "Lists the details of all attribute groups associated with a specific application. The results display in pages.
", "ListTagsForResource": "Lists all of the tags on the resource.
", + "PutConfiguration": " Associates a TagKey configuration to an account.
Syncs the resource with current AppRegistry records.
Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.
", "TagResource": "Assigns one or more tags (key-value pairs) to the specified resource.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
This operation returns an empty response if the call was successful.
", "UntagResource": "Removes tags from a resource.
This operation returns an empty response if the call was successful.
", @@ -26,6 +28,13 @@ "UpdateAttributeGroup": "Updates an existing attribute group with new details.
" }, "shapes": { + "AppRegistryConfiguration": { + "base": "Includes all of the Service Catalog AppRegistry settings.
", + "refs": { + "GetConfigurationResponse$configuration": " Retrieves TagKey configuration from an account.
Associates a TagKey configuration to an account.
Represents a Amazon Web Services Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.
", "refs": { @@ -90,6 +99,7 @@ "DisassociateResourceResponse$resourceArn": "The Amazon resource name (ARN) that specifies the resource.
", "ListTagsForResourceRequest$resourceArn": "The Amazon resource name (ARN) that specifies the resource.
", "ResourceGroup$arn": "The Amazon resource name (ARN) of the resource group.
", + "ResourceInfo$arn": "The Amazon resource name (ARN) that specifies the resource across services.
", "SyncResourceResponse$resourceArn": "The Amazon resource name (ARN) that specifies the resource.
", "TagResourceRequest$resourceArn": "The Amazon resource name (ARN) that specifies the resource.
", "UntagResourceRequest$resourceArn": "The Amazon resource name (ARN) that specifies the resource.
" @@ -148,7 +158,7 @@ "AttributeGroupDetailsList": { "base": null, "refs": { - "ListAttributeGroupsForApplicationResponse$attributeGroupsDetails": "The details related to a specific AttributeGroup.
" + "ListAttributeGroupsForApplicationResponse$attributeGroupsDetails": "The details related to a specific attribute group.
" } }, "AttributeGroupId": { @@ -315,10 +325,15 @@ "refs": { } }, + "GetConfigurationResponse": { + "base": null, + "refs": { + } + }, "Integrations": { "base": "The information about the service integration.
", "refs": { - "GetApplicationResponse$integrations": "The information about the integration of the application with other services, such as Resource Groups.
" + "GetApplicationResponse$integrations": "The information about the integration of the application with other services, such as Resource Groups.
" } }, "InternalServerException": { @@ -402,7 +417,7 @@ "Application$name": "The name of the application. The name must be unique in the region in which you are creating the application.
", "ApplicationSummary$name": "The name of the application. The name must be unique in the region in which you are creating the application.
", "AttributeGroup$name": "The name of the attribute group.
", - "AttributeGroupDetails$name": "The name of the attribute group.
", + "AttributeGroupDetails$name": " This field is no longer supported. We recommend you don't use the field when using ListAttributeGroupsForApplication.
The name of the attribute group.
", "AttributeGroupSummary$name": "The name of the attribute group.
", "CreateApplicationRequest$name": "The name of the application. The name must be unique in the region in which you are creating the application.
", "CreateAttributeGroupRequest$name": "The name of the attribute group.
", @@ -427,12 +442,23 @@ "ListAttributeGroupsResponse$nextToken": "The token to use to get the next page of results after a previous API call.
" } }, + "PutConfigurationRequest": { + "base": null, + "refs": { + } + }, "Resource": { "base": "The information about the resource.
", "refs": { "GetAssociatedResourceResponse$resource": "The resource associated with the application.
" } }, + "ResourceDetails": { + "base": "The details related to the resource.
", + "refs": { + "ResourceInfo$resourceDetails": "The details related to the resource.
" + } + }, "ResourceGroup": { "base": "The information about the resource group integration.
", "refs": { @@ -480,6 +506,7 @@ "AssociateResourceRequest$resourceType": "The type of resource of which the application will be associated.
", "DisassociateResourceRequest$resourceType": "The type of the resource that is being disassociated.
", "GetAssociatedResourceRequest$resourceType": "The type of resource associated with the application.
", + "ResourceInfo$resourceType": "Provides information about the Service Catalog App Registry resource type.
", "SyncResourceRequest$resourceType": "The type of resource of which the application will be associated.
" } }, @@ -497,8 +524,7 @@ "StackArn": { "base": null, "refs": { - "Resource$arn": "The Amazon resource name (ARN) of the resource.
", - "ResourceInfo$arn": "The Amazon resource name (ARN) that specifies the resource across services.
" + "Resource$arn": "The Amazon resource name (ARN) of the resource.
" } }, "String": { @@ -535,12 +561,24 @@ "Tags$key": null } }, + "TagKeyConfig": { + "base": null, + "refs": { + "TagQueryConfiguration$tagKey": "Condition in the IAM policy that associates resources to an application.
" + } + }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of the tag keys to remove from the specified resource.
" } }, + "TagQueryConfiguration": { + "base": " The definition of tagQuery. Specifies which resources are associated with an application.
Includes the definition of a tagQuery.
The value of the tag.
", "Tags$value": null } }, diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json new file mode 100644 index 00000000000..e2b677e60fb --- /dev/null +++ b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json @@ -0,0 +1,340 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json new file mode 100644 index 00000000000..07278e2be4a --- /dev/null +++ b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json @@ -0,0 +1,1291 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-south-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-southeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-3" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://servicecatalog-appregistry.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/sts/2011-06-15/docs-2.json b/models/apis/sts/2011-06-15/docs-2.json index 6aba17256b7..b15a74e729d 100644 --- a/models/apis/sts/2011-06-15/docs-2.json +++ b/models/apis/sts/2011-06-15/docs-2.json @@ -2,13 +2,13 @@ "version": "2.0", "service": "Security Token Service (STS) enables you to request temporary, limited-privilege credentials for Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more information about using this service, see Temporary Security Credentials.
", "operations": { - "AssumeRole": "Returns a set of temporary security credentials that you can use to access Amazon Web Services resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
Permissions
The temporary security credentials created by AssumeRole can be used to make API calls to any Amazon Web Services service with the following exception: You cannot call the Amazon Web Services STS GetFederationToken or GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
When you create a role, you create two policies: A role trust policy that specifies who can assume the role and a permissions policy that specifies what can be done with the role. You specify the trusted principal who is allowed to assume the role in the role trust policy.
To assume a role from a different account, your Amazon Web Services account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.
A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account.
To allow a user to assume a role in the same account, you can do either of the following:
Attach a policy to the user that allows the user to call AssumeRole (as long as the role's trust policy trusts the account).
Add the user as a principal directly in the role's trust policy.
You can do either because the role’s trust policy acts as an IAM resource-based policy. When a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.
Tags
(Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
Using MFA with AssumeRole
(Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.
\"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}
For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.
To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.
Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based Amazon Web Services access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services services.
Session Duration
By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.
Role chaining limits your CLI or Amazon Web Services API role session to a maximum of one hour. When you use the AssumeRole API operation to assume a role, you can specify the duration of your role session with the DurationSeconds parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide a DurationSeconds parameter value greater than one hour, the operation fails.
Permissions
The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
Calling AssumeRoleWithSAML does not require the use of Amazon Web Services security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.
Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
Tags
(Optional) You can configure your IdP to pass attributes into your SAML assertion as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags override the role's tags with the same key.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
SAML Configuration
Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.
For more information, see the following resources:
About SAML 2.0-based Federation in the IAM User Guide.
Creating SAML Identity Providers in the IAM User Guide.
Configuring a Relying Party and Claims in the IAM User Guide.
Creating a Role for SAML 2.0 Federation in the IAM User Guide.
Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or Amazon Cognito federated identities.
For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.
To learn more about Amazon Cognito, see Amazon Cognito Overview in Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the Amazon Web Services SDK for iOS Developer Guide.
Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term Amazon Web Services credentials in the application. You also don't need to deploy server-based proxy services that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services service API operations.
Session Duration
By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.
Permissions
The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
Tags
(Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
Identities
Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.
Calling AssumeRoleWithWebIdentity can result in an entry in your CloudTrail logs. The entry includes the Subject of the provided web identity token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.
For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:
Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.
Web Identity Federation Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to Amazon Web Services.
Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials.
Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3.
Returns a set of temporary security credentials that you can use to access Amazon Web Services resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
Permissions
The temporary security credentials created by AssumeRole can be used to make API calls to any Amazon Web Services service with the following exception: You cannot call the Amazon Web Services STS GetFederationToken or GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
When you create a role, you create two policies: A role trust policy that specifies who can assume the role and a permissions policy that specifies what can be done with the role. You specify the trusted principal who is allowed to assume the role in the role trust policy.
To assume a role from a different account, your Amazon Web Services account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.
A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account.
To allow a user to assume a role in the same account, you can do either of the following:
Attach a policy to the user that allows the user to call AssumeRole (as long as the role's trust policy trusts the account).
Add the user as a principal directly in the role's trust policy.
You can do either because the role’s trust policy acts as an IAM resource-based policy. When a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.
Tags
(Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
Using MFA with AssumeRole
(Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.
\"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}
For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.
To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.
Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based Amazon Web Services access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services services.
Session Duration
By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.
Role chaining limits your CLI or Amazon Web Services API role session to a maximum of one hour. When you use the AssumeRole API operation to assume a role, you can specify the duration of your role session with the DurationSeconds parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide a DurationSeconds parameter value greater than one hour, the operation fails.
Permissions
The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
Calling AssumeRoleWithSAML does not require the use of Amazon Web Services security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.
Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
Tags
(Optional) You can configure your IdP to pass attributes into your SAML assertion as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags override the role's tags with the same key.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
SAML Configuration
Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.
For more information, see the following resources:
About SAML 2.0-based Federation in the IAM User Guide.
Creating SAML Identity Providers in the IAM User Guide.
Configuring a Relying Party and Claims in the IAM User Guide.
Creating a Role for SAML 2.0 Federation in the IAM User Guide.
Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or Amazon Cognito federated identities.
For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.
To learn more about Amazon Cognito, see Amazon Cognito Overview in Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the Amazon Web Services SDK for iOS Developer Guide.
Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term Amazon Web Services credentials in the application. You also don't need to deploy server-based proxy services that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services service API operations.
Session Duration
By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.
Permissions
The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
Tags
(Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
Identities
Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.
Calling AssumeRoleWithWebIdentity can result in an entry in your CloudTrail logs. The entry includes the Subject of the provided web identity token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.
For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:
Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.
Web Identity Federation Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to Amazon Web Services.
Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials.
Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3.
Decodes additional information about the authorization status of a request from an encoded message returned in response to an Amazon Web Services request.
For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can provide details about this authorization failure.
Only certain Amazon Web Services operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization status can contain privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions through an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.
The principal who made the request.
The requested action.
The requested resource.
The values of condition keys in the context of the user's request.
Returns the account identifier for the specified access key ID.
Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about access keys, see Managing Access Keys for IAM Users in the IAM User Guide.
When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account to which the keys belong. Access key IDs beginning with AKIA are long-term credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with ASIA are temporary credentials that are created using STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA access key, view the STS events in your CloudTrail logs in the IAM User Guide.
This operation does not indicate the state of the access key. The key might be active, inactive, or deleted. Active keys might not have permissions to perform an operation. Providing a deleted access key might return an error that the key doesn't exist.
", "GetCallerIdentity": "Returns details about the IAM user or role whose credentials are used to call the operation.
No permissions are required to perform this operation. If an administrator adds a policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity action, you can still perform this operation. Permissions are not required because the same information is returned when an IAM user or role is denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide.
Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide.
You can also call GetFederationToken using the security credentials of an Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide.
Session duration
The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root user credentials have a maximum duration of 3,600 seconds (1 hour).
Permissions
You can use the temporary credentials created by GetFederationToken in any Amazon Web Services service except the following:
You cannot call any IAM operations using the CLI or the Amazon Web Services API.
You cannot call any STS operations except GetCallerIdentity.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters.
Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
You can use the credentials to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions granted by the session policies.
Tags
(Optional) You can pass tag key-value pairs to your session. These are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the user that you are federating has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the user tag.
Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide.
You can also call GetFederationToken using the security credentials of an Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide.
Session duration
The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root user credentials have a maximum duration of 3,600 seconds (1 hour).
Permissions
You can use the temporary credentials created by GetFederationToken in any Amazon Web Services service except the following:
You cannot call any IAM operations using the CLI or the Amazon Web Services API.
You cannot call any STS operations except GetCallerIdentity.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters.
Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
You can use the credentials to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions granted by the session policies.
Tags
(Optional) You can pass tag key-value pairs to your session. These are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the user that you are federating has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the user tag.
Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
No permissions are required for users to perform this operation. The purpose of the sts:GetSessionToken operation is to authenticate the user using MFA. You cannot use policies to control authentication operations. For more information, see Permissions for GetSessionToken in the IAM User Guide.
Session Duration
The GetSessionToken operation must be called by using the long-term Amazon Web Services security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
Permissions
The temporary security credentials created by GetSessionToken can be used to make API calls to any Amazon Web Services service with the following exceptions:
You cannot call any IAM API operations unless MFA authentication information is included in the request.
You cannot call any STS API except AssumeRole or GetCallerIdentity.
We recommend that you do not call GetSessionToken with Amazon Web Services account root user credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with Amazon Web Services.
The credentials that are returned by GetSessionToken are based on permissions associated with the user whose credentials were used to call the operation. If GetSessionToken is called using Amazon Web Services account root user credentials, the temporary credentials have root user permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
", - "AssumeRoleWithSAMLRequest$PolicyArns": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
", - "AssumeRoleWithWebIdentityRequest$PolicyArns": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
", - "GetFederationTokenRequest$PolicyArns": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
", + "AssumeRoleWithSAMLRequest$PolicyArns": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
", + "AssumeRoleWithWebIdentityRequest$PolicyArns": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
", + "GetFederationTokenRequest$PolicyArns": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.
Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
", - "GetFederationTokenRequest$Tags": "A list of session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.
Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
", + "GetFederationTokenRequest$Tags": "A list of session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
", "operations": { - "AnalyzeDocument": "Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of Block objects.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
", + "AnalyzeDocument": "Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).
Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of Block objects.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
", "AnalyzeExpense": " AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows:
LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.
SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
", @@ -81,7 +81,7 @@ "BlockType": { "base": null, "refs": { - "Block$BlockType": "The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. To perform both forms and table analysis, add TABLES and FORMS to FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either TABLES or FORMS. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
", "CreateConnectionAlias": "Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
", "CreateIpGroup": "Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
", + "CreateStandbyWorkspaces": "Creates a Standby WorkSpace in a secondary region.
", "CreateTags": "Creates the specified tags for the specified WorkSpaces resource.
", "CreateUpdatedWorkspaceImage": "Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
", @@ -249,6 +250,12 @@ "WorkspaceBundle$Owner": "The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
The type of WorkSpace bundle.
" + } + }, "CertificateAuthorityArn": { "base": null, "refs": { @@ -492,6 +499,16 @@ "refs": { } }, + "CreateStandbyWorkspacesRequest": { + "base": null, + "refs": { + } + }, + "CreateStandbyWorkspacesResult": { + "base": null, + "refs": { + } + }, "CreateTagsRequest": { "base": null, "refs": { @@ -888,6 +905,7 @@ "base": null, "refs": { "AccountModification$ErrorMessage": "The text of the error message that is returned if the configuration of BYOL cannot be modified.
", + "FailedCreateStandbyWorkspacesRequest$ErrorMessage": "The text of the error message that is returned if the Standby WorkSpace could not be created.
", "FailedCreateWorkspaceRequest$ErrorMessage": "The text of the error message that is returned if the WorkSpace cannot be created.
", "FailedWorkspaceChangeRequest$ErrorMessage": "The text of the error message that is returned if the WorkSpace cannot be rebooted.
", "Workspace$ErrorMessage": "The text of the error message that is returned if the WorkSpace cannot be created.
", @@ -915,7 +933,9 @@ "ModifySelfservicePermissionsRequest$ResourceId": "The identifier of the directory.
", "ModifyWorkspaceAccessPropertiesRequest$ResourceId": "The identifier of the directory.
", "ModifyWorkspaceCreationPropertiesRequest$ResourceId": "The identifier of the directory.
", + "PendingCreateStandbyWorkspacesRequest$DirectoryId": "The identifier of the directory for the Standby WorkSpace.
", "RegisterWorkspaceDirectoryRequest$DirectoryId": "The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
", + "StandbyWorkspace$DirectoryId": "The identifier of the directory for the Standby WorkSpace.
", "UpdateConnectClientAddInRequest$ResourceId": "The directory identifier for which the client add-in is configured.
", "Workspace$DirectoryId": "The identifier of the Directory Service directory for the WorkSpace.
", "WorkspaceDirectory$DirectoryId": "The directory identifier.
", @@ -1004,6 +1024,18 @@ "WorkspacesDefaultRoleNotFoundException$message": null } }, + "FailedCreateStandbyWorkspacesRequest": { + "base": "Describes the Standby WorkSpace that could not be created.
", + "refs": { + "FailedCreateStandbyWorkspacesRequestList$member": null + } + }, + "FailedCreateStandbyWorkspacesRequestList": { + "base": null, + "refs": { + "CreateStandbyWorkspacesResult$FailedStandbyRequests": "Information about the Standby WorkSpace that could not be created.
" + } + }, "FailedCreateWorkspaceRequest": { "base": "Describes a WorkSpace that cannot be created.
", "refs": { @@ -1458,6 +1490,18 @@ "ListAvailableManagementCidrRangesResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" } }, + "PendingCreateStandbyWorkspacesRequest": { + "base": "Information about the Standby WorkSpace.
", + "refs": { + "PendingCreateStandbyWorkspacesRequestList$member": null + } + }, + "PendingCreateStandbyWorkspacesRequestList": { + "base": null, + "refs": { + "CreateStandbyWorkspacesResult$PendingStandbyRequests": "Information about the Standby WorkSpace that was created.
" + } + }, "Protocol": { "base": null, "refs": { @@ -1528,7 +1572,9 @@ "Region": { "base": null, "refs": { - "CopyWorkspaceImageRequest$SourceRegion": "The identifier of the source Region.
" + "CopyWorkspaceImageRequest$SourceRegion": "The identifier of the source Region.
", + "CreateStandbyWorkspacesRequest$PrimaryRegion": "The Region of the primary WorkSpace.
", + "RelatedWorkspaceProperties$Region": "The Region of the related WorkSpace.
" } }, "RegisterWorkspaceDirectoryRequest": { @@ -1547,6 +1593,18 @@ "WorkspaceDirectory$RegistrationCode": "The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
" } }, + "RelatedWorkspaceProperties": { + "base": "Describes the related WorkSpace. The related WorkSpace could be a Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.
", + "refs": { + "RelatedWorkspaces$member": null + } + }, + "RelatedWorkspaces": { + "base": null, + "refs": { + "Workspace$RelatedWorkspaces": "The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.
" + } + }, "ResourceAlreadyExistsException": { "base": "The specified resource already exists.
", "refs": { @@ -1675,6 +1733,25 @@ "DescribeWorkspaceSnapshotsResult$RestoreSnapshots": "Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
" } }, + "StandbyWorkspace": { + "base": "Describes a Standby WorkSpace.
", + "refs": { + "FailedCreateStandbyWorkspacesRequest$StandbyWorkspaceRequest": "Information about the Standby WorkSpace that could not be created.
", + "StandbyWorkspacesList$member": null + } + }, + "StandbyWorkspaceRelationshipType": { + "base": null, + "refs": { + "RelatedWorkspaceProperties$Type": "Indicates the type of WorkSpace.
" + } + }, + "StandbyWorkspacesList": { + "base": null, + "refs": { + "CreateStandbyWorkspacesRequest$StandbyWorkspaces": "Information about the Standby WorkSpace to be created.
" + } + }, "StartRequest": { "base": "Information used to start a WorkSpace.
", "refs": { @@ -1764,6 +1841,7 @@ "DescribeTagsResult$TagList": "The tags.
", "ImportWorkspaceImageRequest$Tags": "The tags. Each WorkSpaces resource can have a maximum of 50 tags.
", "RegisterWorkspaceDirectoryRequest$Tags": "The tags associated with the directory.
", + "StandbyWorkspace$Tags": "The tags associated with the Standby WorkSpace.
", "WorkspaceRequest$Tags": "The tags for the WorkSpace.
" } }, @@ -1897,6 +1975,7 @@ "base": null, "refs": { "DescribeWorkspacesRequest$UserName": "The name of the directory user. You must specify this parameter with DirectoryId.
Describes the Standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
", "Workspace$UserName": "The user for the WorkSpace.
", "WorkspaceDirectory$CustomerUserName": "The user name for the service account.
", "WorkspaceRequest$UserName": "The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
" @@ -1918,6 +1997,7 @@ "VolumeEncryptionKey": { "base": null, "refs": { + "StandbyWorkspace$VolumeEncryptionKey": "The volume encryption key of the Standby WorkSpace.
", "Workspace$VolumeEncryptionKey": "The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
", "WorkspaceRequest$VolumeEncryptionKey": "The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
" } @@ -1954,6 +2034,12 @@ "CreateWorkspaceBundleRequest$BundleName": "The name of the bundle.
" } }, + "WorkspaceBundleState": { + "base": null, + "refs": { + "WorkspaceBundle$State": "The state of the WorkSpace bundle.
" + } + }, "WorkspaceConnectionStatus": { "base": "Describes the connection status of a WorkSpace.
", "refs": { @@ -1994,6 +2080,7 @@ "base": null, "refs": { "AccountModification$ErrorCode": "The error code that is returned if the configuration of BYOL cannot be modified.
", + "FailedCreateStandbyWorkspacesRequest$ErrorCode": "The error code that is returned if the Standby WorkSpace could not be created.
", "Workspace$ErrorCode": "The error code that is returned if the WorkSpace cannot be created.
" } }, @@ -2008,9 +2095,12 @@ "MigrateWorkspaceResult$TargetWorkspaceId": "The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
", "ModifyWorkspacePropertiesRequest$WorkspaceId": "The identifier of the WorkSpace.
", "ModifyWorkspaceStateRequest$WorkspaceId": "The identifier of the WorkSpace.
", + "PendingCreateStandbyWorkspacesRequest$WorkspaceId": "The identifier of the Standby WorkSpace.
", "RebootRequest$WorkspaceId": "The identifier of the WorkSpace.
", "RebuildRequest$WorkspaceId": "The identifier of the WorkSpace.
", + "RelatedWorkspaceProperties$WorkspaceId": "The identifier of the related WorkSpace.
", "RestoreWorkspaceRequest$WorkspaceId": "The identifier of the WorkSpace.
", + "StandbyWorkspace$PrimaryWorkspaceId": "The identifier of the Standby WorkSpace.
", "StartRequest$WorkspaceId": "The identifier of the WorkSpace.
", "StopRequest$WorkspaceId": "The identifier of the WorkSpace.
", "TerminateRequest$WorkspaceId": "The identifier of the WorkSpace.
", @@ -2143,6 +2233,8 @@ "WorkspaceState": { "base": null, "refs": { + "PendingCreateStandbyWorkspacesRequest$State": "The operational state of the Standby WorkSpace.
", + "RelatedWorkspaceProperties$State": "Indicates the state of the WorkSpace.
", "Workspace$State": "The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
The maximum number of metric definitions that one destination can contain -// is 2000.
Extended metrics sent are charged as CloudWatch custom -// metrics. Each combination of additional dimension name and dimension value -// counts as a custom metric. For more information, see Amazon -// CloudWatch Pricing.
You must have already created a destination -// for the metrics before you send them. For more information, see PutRumMetricsDestination.
-//If some metric definitions specified in a BatchCreateRumMetricDefinitions
-// operations are not valid, those metric definitions fail and return errors,
-// but all valid metric definitions in the same operation still succeed.
You can't include both ExcludedPages and IncludedPages
- // in the same operation.
You can associate as many as 50 tags with an app monitor.
For - // more information, see Tagging - // Amazon Web Services resources.
+ // You can associate as many as 50 tags with an app monitor. + // + // For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Tags map[string]*string `type:"map"` } @@ -3052,6 +3073,12 @@ func (s *CreateAppMonitorInput) SetAppMonitorConfiguration(v *AppMonitorConfigur return s } +// SetCustomEvents sets the CustomEvents field's value. +func (s *CreateAppMonitorInput) SetCustomEvents(v *CustomEvents) *CreateAppMonitorInput { + s.CustomEvents = v + return s +} + // SetCwLogEnabled sets the CwLogEnabled field's value. func (s *CreateAppMonitorInput) SetCwLogEnabled(v bool) *CreateAppMonitorInput { s.CwLogEnabled = &v @@ -3107,6 +3134,39 @@ func (s *CreateAppMonitorOutput) SetId(v string) *CreateAppMonitorOutput { return s } +// A structure that contains information about custom events for this app monitor. +type CustomEvents struct { + _ struct{} `type:"structure"` + + // Specifies whether this app monitor allows the web client to define and send + // custom events. The default is for custom events to be DISABLED. + Status *string `type:"string" enum:"CustomEventsStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomEvents) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomEvents) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *CustomEvents) SetStatus(v string) *CustomEvents { + s.Status = &v + return s +} + // A structure that contains the information about whether the app monitor stores // copies of the data that RUM collects in CloudWatch Logs. If it does, this // structure also contains the name of the log group. @@ -4104,7 +4164,7 @@ type MetricDefinitionRequest struct { // // * "event_details.fileType": "FileType" // - // All dimensions listed in this field must also be included in EventPattern.
You can use the collected data to quickly identify and debug client-side -// performance issues. CloudWatch RUM helps you visualize anomalies in your -// application performance and find relevant debugging data such as error -// messages, stack traces, and user sessions. You can also use RUM to understand -// the range of end-user impact including the number of users, geolocations, -// and browsers used.
+// You can use the collected data to quickly identify and debug client-side +// performance issues. CloudWatch RUM helps you visualize anomalies in your +// application performance and find relevant debugging data such as error messages, +// stack traces, and user sessions. You can also use RUM to understand the range +// of end-user impact including the number of users, geolocations, and browsers +// used. // // See https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10 for more information on this service. // diff --git a/service/databasemigrationservice/api.go b/service/databasemigrationservice/api.go index 837713ae8ae..9bae03e9be4 100644 --- a/service/databasemigrationservice/api.go +++ b/service/databasemigrationservice/api.go @@ -8052,8 +8052,9 @@ type CreateEndpointInput struct { // The type of engine for the endpoint. Valid values, depending on the EndpointType // value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", - // "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune". + // "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", + // "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", + // and "babelfish". // // EngineName is a required field EngineName *string `type:"string" required:"true"` @@ -8845,6 +8846,11 @@ type CreateReplicationInstanceInput struct { // to true. MultiAZ *bool `type:"boolean"` + // The type of IP address protocol used by a replication instance, such as IPv4 + // only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only + // is not yet supported. + NetworkType *string `type:"string"` + // The weekly time range during which system maintenance can occur, in Universal // Coordinated Time (UTC). // @@ -8988,6 +8994,12 @@ func (s *CreateReplicationInstanceInput) SetMultiAZ(v bool) *CreateReplicationIn return s } +// SetNetworkType sets the NetworkType field's value. +func (s *CreateReplicationInstanceInput) SetNetworkType(v string) *CreateReplicationInstanceInput { + s.NetworkType = &v + return s +} + // SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value. func (s *CreateReplicationInstanceInput) SetPreferredMaintenanceWindow(v string) *CreateReplicationInstanceInput { s.PreferredMaintenanceWindow = &v @@ -14039,13 +14051,14 @@ type Endpoint struct { EndpointType *string `type:"string" enum:"ReplicationEndpointTypeValue"` // The expanded name for the engine name. For example, if the EngineName parameter - // is "aurora," this value would be "Amazon Aurora MySQL." + // is "aurora", this value would be "Amazon Aurora MySQL". EngineDisplayName *string `type:"string"` // The database engine name. Valid values, depending on the EndpointType, include // "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", - // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune". + // "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", + // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", + // and "babelfish". EngineName *string `type:"string"` // Value returned by a call to CreateEndpoint that can be used for cross-account @@ -16862,10 +16875,11 @@ type ModifyEndpointInput struct { // The type of endpoint. Valid values are source and target. EndpointType *string `type:"string" enum:"ReplicationEndpointTypeValue"` - // The type of engine for the endpoint. Valid values, depending on the EndpointType, - // include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", - // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune". + // The database engine name. Valid values, depending on the EndpointType, include + // "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", + // "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", + // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", + // and "babelfish". EngineName *string `type:"string"` // If this attribute is Y, the current call to ModifyEndpoint replaces all existing @@ -17448,6 +17462,11 @@ type ModifyReplicationInstanceInput struct { // to true. MultiAZ *bool `type:"boolean"` + // The type of IP address protocol used by a replication instance, such as IPv4 + // only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only + // is not yet supported. + NetworkType *string `type:"string"` + // The weekly time range (in UTC) during which system maintenance can occur, // which might result in an outage. Changing this parameter does not result // in an outage, except in the following situation, and the change is asynchronously @@ -17555,6 +17574,12 @@ func (s *ModifyReplicationInstanceInput) SetMultiAZ(v bool) *ModifyReplicationIn return s } +// SetNetworkType sets the NetworkType field's value. +func (s *ModifyReplicationInstanceInput) SetNetworkType(v string) *ModifyReplicationInstanceInput { + s.NetworkType = &v + return s +} + // SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value. func (s *ModifyReplicationInstanceInput) SetPreferredMaintenanceWindow(v string) *ModifyReplicationInstanceInput { s.PreferredMaintenanceWindow = &v @@ -18552,8 +18577,8 @@ type OracleSettings struct { ArchivedLogDestId *int64 `type:"integer"` // When this field is set to Y, DMS only accesses the archived redo logs. If - // the archived redo logs are stored on Oracle ASM only, the DMS user account - // needs to be granted ASM privileges. + // the archived redo logs are stored on Automatic Storage Management (ASM) only, + // the DMS user account needs to be granted ASM privileges. ArchivedLogsOnly *bool `type:"boolean"` // For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) @@ -18701,7 +18726,7 @@ type OracleSettings struct { // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string `type:"string"` - // Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). + // Required only if your Oracle endpoint uses Automatic Storage Management (ASM). // The full ARN of the IAM role that specifies DMS as the trusted entity and // grants the required permissions to access the SecretsManagerOracleAsmSecret. // This SecretsManagerOracleAsmSecret has the secret value that allows access @@ -18717,7 +18742,7 @@ type OracleSettings struct { // in the Database Migration Service User Guide. SecretsManagerOracleAsmAccessRoleArn *string `type:"string"` - // Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). + // Required only if your Oracle endpoint uses Automatic Storage Management (ASM). // The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret // that contains the Oracle ASM connection details for the Oracle endpoint. SecretsManagerOracleAsmSecretId *string `type:"string"` @@ -20557,6 +20582,11 @@ type ReplicationInstance struct { // to true. MultiAZ *bool `type:"boolean"` + // The type of IP address protocol used by a replication instance, such as IPv4 + // only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only + // is not yet supported. + NetworkType *string `type:"string"` + // The pending modification values. PendingModifiedValues *ReplicationPendingModifiedValues `type:"structure"` @@ -20595,6 +20625,9 @@ type ReplicationInstance struct { // Example: myrepinstance ReplicationInstanceIdentifier *string `type:"string"` + // One or more IPv6 addresses for the replication instance. + ReplicationInstanceIpv6Addresses []*string `type:"list"` + // The private IP address of the replication instance. // // Deprecated: ReplicationInstancePrivateIpAddress has been deprecated @@ -20722,6 +20755,12 @@ func (s *ReplicationInstance) SetMultiAZ(v bool) *ReplicationInstance { return s } +// SetNetworkType sets the NetworkType field's value. +func (s *ReplicationInstance) SetNetworkType(v string) *ReplicationInstance { + s.NetworkType = &v + return s +} + // SetPendingModifiedValues sets the PendingModifiedValues field's value. func (s *ReplicationInstance) SetPendingModifiedValues(v *ReplicationPendingModifiedValues) *ReplicationInstance { s.PendingModifiedValues = v @@ -20758,6 +20797,12 @@ func (s *ReplicationInstance) SetReplicationInstanceIdentifier(v string) *Replic return s } +// SetReplicationInstanceIpv6Addresses sets the ReplicationInstanceIpv6Addresses field's value. +func (s *ReplicationInstance) SetReplicationInstanceIpv6Addresses(v []*string) *ReplicationInstance { + s.ReplicationInstanceIpv6Addresses = v + return s +} + // SetReplicationInstancePrivateIpAddress sets the ReplicationInstancePrivateIpAddress field's value. func (s *ReplicationInstance) SetReplicationInstancePrivateIpAddress(v string) *ReplicationInstance { s.ReplicationInstancePrivateIpAddress = &v @@ -20874,6 +20919,11 @@ type ReplicationPendingModifiedValues struct { // to true. MultiAZ *bool `type:"boolean"` + // The type of IP address protocol used by a replication instance, such as IPv4 + // only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only + // is not yet supported. + NetworkType *string `type:"string"` + // The compute and memory capacity of the replication instance as defined for // the specified replication instance class. // @@ -20919,6 +20969,12 @@ func (s *ReplicationPendingModifiedValues) SetMultiAZ(v bool) *ReplicationPendin return s } +// SetNetworkType sets the NetworkType field's value. +func (s *ReplicationPendingModifiedValues) SetNetworkType(v string) *ReplicationPendingModifiedValues { + s.NetworkType = &v + return s +} + // SetReplicationInstanceClass sets the ReplicationInstanceClass field's value. func (s *ReplicationPendingModifiedValues) SetReplicationInstanceClass(v string) *ReplicationPendingModifiedValues { s.ReplicationInstanceClass = &v @@ -20942,6 +20998,11 @@ type ReplicationSubnetGroup struct { // The subnets that are in the subnet group. Subnets []*Subnet `type:"list"` + // The IP addressing protocol supported by the subnet group. This is used by + // a replication instance with values such as IPv4 only or Dual-stack that supports + // both IPv4 and IPv6 addressing. IPv6 only is not yet supported. + SupportedNetworkTypes []*string `type:"list"` + // The ID of the VPC. VpcId *string `type:"string"` } @@ -20988,6 +21049,12 @@ func (s *ReplicationSubnetGroup) SetSubnets(v []*Subnet) *ReplicationSubnetGroup return s } +// SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value. +func (s *ReplicationSubnetGroup) SetSupportedNetworkTypes(v []*string) *ReplicationSubnetGroup { + s.SupportedNetworkTypes = v + return s +} + // SetVpcId sets the VpcId field's value. func (s *ReplicationSubnetGroup) SetVpcId(v string) *ReplicationSubnetGroup { s.VpcId = &v @@ -22414,7 +22481,7 @@ type S3Settings struct { // The default value is 60 seconds. CdcMaxBatchInterval *int64 `type:"integer"` - // Minimum file size, defined in megabytes, to reach for a file output to Amazon + // Minimum file size, defined in kilobytes, to reach for a file output to Amazon // S3. // // When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file @@ -24049,13 +24116,14 @@ type SupportedEndpointType struct { EndpointType *string `type:"string" enum:"ReplicationEndpointTypeValue"` // The expanded name for the engine name. For example, if the EngineName parameter - // is "aurora," this value would be "Amazon Aurora MySQL." + // is "aurora", this value would be "Amazon Aurora MySQL". EngineDisplayName *string `type:"string"` // The database engine name. Valid values, depending on the EndpointType, include // "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", - // "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune". + // "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", + // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", + // and "babelfish". EngineName *string `type:"string"` // The earliest DMS engine version that supports this endpoint engine. Note @@ -24224,6 +24292,19 @@ func (s *SybaseSettings) SetUsername(v string) *SybaseSettings { type TableStatistics struct { _ struct{} `type:"structure"` + // The number of data definition language (DDL) statements used to build and + // modify the structure of your tables applied on the target. + AppliedDdls *int64 `type:"long"` + + // The number of delete actions applied on a target table. + AppliedDeletes *int64 `type:"long"` + + // The number of insert actions applied on a target table. + AppliedInserts *int64 `type:"long"` + + // The number of update actions applied on a target table. + AppliedUpdates *int64 `type:"long"` + // The data definition language (DDL) used to build and modify the structure // of your tables. Ddls *int64 `type:"long"` @@ -24338,6 +24419,30 @@ func (s TableStatistics) GoString() string { return s.String() } +// SetAppliedDdls sets the AppliedDdls field's value. +func (s *TableStatistics) SetAppliedDdls(v int64) *TableStatistics { + s.AppliedDdls = &v + return s +} + +// SetAppliedDeletes sets the AppliedDeletes field's value. +func (s *TableStatistics) SetAppliedDeletes(v int64) *TableStatistics { + s.AppliedDeletes = &v + return s +} + +// SetAppliedInserts sets the AppliedInserts field's value. +func (s *TableStatistics) SetAppliedInserts(v int64) *TableStatistics { + s.AppliedInserts = &v + return s +} + +// SetAppliedUpdates sets the AppliedUpdates field's value. +func (s *TableStatistics) SetAppliedUpdates(v int64) *TableStatistics { + s.AppliedUpdates = &v + return s +} + // SetDdls sets the Ddls field's value. func (s *TableStatistics) SetDdls(v int64) *TableStatistics { s.Ddls = &v diff --git a/service/ec2/api.go b/service/ec2/api.go index 356345e9359..feb5047fce4 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -64469,10 +64469,12 @@ type CreateFlowLogsInput struct { LogDestinationType *string `type:"string" enum:"LogDestinationType"` // The fields to include in the flow log record. List the fields in the order - // in which they should appear. For more information about the available fields, - // see Flow log records (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records). - // If you omit this parameter, the flow log is created using the default format. - // If you specify this parameter, you must include at least one field. + // in which they should appear. If you omit this parameter, the flow log is + // created using the default format. If you specify this parameter, you must + // include at least one field. For more information about the available fields, + // see Flow log records (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) + // in the Amazon VPC User Guide or Transit Gateway Flow Log records (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) + // in the Amazon Web Services Transit Gateway Guide. // // Specify the fields using the ${field-id} format, separated by spaces. For // the CLI, surround this parameter value with single quotes on Linux or double @@ -64486,8 +64488,9 @@ type CreateFlowLogsInput struct { LogGroupName *string `type:"string"` // The maximum interval of time during which a flow of packets is captured and - // aggregated into a flow log record. You can specify 60 seconds (1 minute) - // or 600 seconds (10 minutes). + // aggregated into a flow log record. The possible values are 60 seconds (1 + // minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for + // transit gateway resource types. // // When a network interface is attached to a Nitro-based instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances), // the aggregation interval is always 60 seconds or less, regardless of the @@ -64499,7 +64502,8 @@ type CreateFlowLogsInput struct { // The IDs of the resources to monitor. For example, if the resource type is // VPC, specify the IDs of the VPCs. // - // Constraints: Maximum of 1000 resources + // Constraints: Maximum of 25 for transit gateway resource types. Maximum of + // 1000 for the other resource types. // // ResourceIds is a required field ResourceIds []*string `locationName:"ResourceId" locationNameList:"item" type:"list" required:"true"` @@ -64513,7 +64517,8 @@ type CreateFlowLogsInput struct { TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` // The type of traffic to monitor (accepted traffic, rejected traffic, or all - // traffic). + // traffic). This parameter is not supported for transit gateway resource types. + // It is required for the other resource types. TrafficType *string `type:"string" enum:"TrafficType"` } @@ -66941,6 +66946,10 @@ type CreateNatGatewayInput struct { // it is UnauthorizedOperation. DryRun *bool `type:"boolean"` + // The private IPv4 address to assign to the NAT gateway. If you don't provide + // an address, a private IPv4 address will be automatically assigned. + PrivateIpAddress *string `type:"string"` + // The subnet in which to create the NAT gateway. // // SubnetId is a required field @@ -67005,6 +67014,12 @@ func (s *CreateNatGatewayInput) SetDryRun(v bool) *CreateNatGatewayInput { return s } +// SetPrivateIpAddress sets the PrivateIpAddress field's value. +func (s *CreateNatGatewayInput) SetPrivateIpAddress(v string) *CreateNatGatewayInput { + s.PrivateIpAddress = &v + return s +} + // SetSubnetId sets the SubnetId field's value. func (s *CreateNatGatewayInput) SetSubnetId(v string) *CreateNatGatewayInput { s.SubnetId = &v @@ -155411,44 +155426,27 @@ type SpotFleetRequestConfigData struct { // For more information, see Allocation strategies for Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) // in the Amazon EC2 User Guide. // - // priceCapacityOptimized (recommended) - // - // Spot Fleet identifies the pools with the highest capacity availability for - // the number of instances that are launching. This means that we will request - // Spot Instances from the pools that we believe have the lowest chance of interruption - // in the near term. Spot Fleet then requests Spot Instances from the lowest - // priced of these pools. - // - // capacityOptimized - // - // Spot Fleet identifies the pools with the highest capacity availability for - // the number of instances that are launching. This means that we will request - // Spot Instances from the pools that we believe have the lowest chance of interruption - // in the near term. To give certain instance types a higher chance of launching - // first, use capacityOptimizedPrioritized. Set a priority for each instance - // type by using the Priority parameter for LaunchTemplateOverrides. You can - // assign the same priority to different LaunchTemplateOverrides. EC2 implements - // the priorities on a best-effort basis, but optimizes for capacity first. - // capacityOptimizedPrioritized is supported only if your Spot Fleet uses a - // launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, - // the same priority is applied when fulfilling On-Demand capacity. - // - // diversified - // - // Spot Fleet requests instances from all of the Spot Instance pools that you - // specify. - // - // lowestPrice - // - // Spot Fleet requests instances from the lowest priced Spot Instance pool that - // has available capacity. If the lowest priced pool doesn't have available - // capacity, the Spot Instances come from the next lowest priced pool that has - // available capacity. If a pool runs out of capacity before fulfilling your - // desired capacity, Spot Fleet will continue to fulfill your request by drawing - // from the next lowest priced pool. To ensure that your desired capacity is - // met, you might receive Spot Instances from several pools. Because this strategy - // only considers instance price and not capacity availability, it might lead - // to high interruption rates. + // lowestPrice - Spot Fleet launches instances from the lowest-price Spot Instance + // pool that has available capacity. If the cheapest pool doesn't have available + // capacity, the Spot Instances come from the next cheapest pool that has available + // capacity. If a pool runs out of capacity before fulfilling your desired capacity, + // Spot Fleet will continue to fulfill your request by drawing from the next + // cheapest pool. To ensure that your desired capacity is met, you might receive + // Spot Instances from several pools. + // + // diversified - Spot Fleet launches instances from all of the Spot Instance + // pools that you specify. + // + // capacityOptimized (recommended) - Spot Fleet launches instances from Spot + // Instance pools with optimal capacity for the number of instances that are + // launching. To give certain instance types a higher chance of launching first, + // use capacityOptimizedPrioritized. Set a priority for each instance type by + // using the Priority parameter for LaunchTemplateOverrides. You can assign + // the same priority to different LaunchTemplateOverrides. EC2 implements the + // priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized + // is supported only if your Spot Fleet uses a launch template. Note that if + // the OnDemandAllocationStrategy is set to prioritized, the same priority is + // applied when fulfilling On-Demand capacity. // // Default: lowestPrice AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"AllocationStrategy"` @@ -156312,44 +156310,27 @@ type SpotOptions struct { // For more information, see Allocation strategies for Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) // in the Amazon EC2 User Guide. // - // price-capacity-optimized (recommended) - // - // EC2 Fleet identifies the pools with the highest capacity availability for - // the number of instances that are launching. This means that we will request - // Spot Instances from the pools that we believe have the lowest chance of interruption - // in the near term. EC2 Fleet then requests Spot Instances from the lowest - // priced of these pools. - // - // capacity-optimized - // - // EC2 Fleet identifies the pools with the highest capacity availability for - // the number of instances that are launching. This means that we will request - // Spot Instances from the pools that we believe have the lowest chance of interruption - // in the near term. To give certain instance types a higher chance of launching - // first, use capacity-optimized-prioritized. Set a priority for each instance - // type by using the Priority parameter for LaunchTemplateOverrides. You can - // assign the same priority to different LaunchTemplateOverrides. EC2 implements - // the priorities on a best-effort basis, but optimizes for capacity first. - // capacity-optimized-prioritized is supported only if your EC2 Fleet uses a - // launch template. Note that if the On-Demand AllocationStrategy is set to - // prioritized, the same priority is applied when fulfilling On-Demand capacity. - // - // diversified - // - // EC2 Fleet requests instances from all of the Spot Instance pools that you - // specify. - // - // lowest-price - // - // EC2 Fleet requests instances from the lowest priced Spot Instance pool that - // has available capacity. If the lowest priced pool doesn't have available - // capacity, the Spot Instances come from the next lowest priced pool that has - // available capacity. If a pool runs out of capacity before fulfilling your - // desired capacity, EC2 Fleet will continue to fulfill your request by drawing - // from the next lowest priced pool. To ensure that your desired capacity is - // met, you might receive Spot Instances from several pools. Because this strategy - // only considers instance price and not capacity availability, it might lead - // to high interruption rates. + // lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance + // pool that has available capacity. If the cheapest pool doesn't have available + // capacity, the Spot Instances come from the next cheapest pool that has available + // capacity. If a pool runs out of capacity before fulfilling your desired capacity, + // EC2 Fleet will continue to fulfill your request by drawing from the next + // cheapest pool. To ensure that your desired capacity is met, you might receive + // Spot Instances from several pools. + // + // diversified - EC2 Fleet launches instances from all of the Spot Instance + // pools that you specify. + // + // capacity-optimized (recommended) - EC2 Fleet launches instances from Spot + // Instance pools with optimal capacity for the number of instances that are + // launching. To give certain instance types a higher chance of launching first, + // use capacity-optimized-prioritized. Set a priority for each instance type + // by using the Priority parameter for LaunchTemplateOverrides. You can assign + // the same priority to different LaunchTemplateOverrides. EC2 implements the + // priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized + // is supported only if your fleet uses a launch template. Note that if the + // On-Demand AllocationStrategy is set to prioritized, the same priority is + // applied when fulfilling On-Demand capacity. // // Default: lowest-price AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"SpotAllocationStrategy"` @@ -156484,44 +156465,27 @@ type SpotOptionsRequest struct { // For more information, see Allocation strategies for Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) // in the Amazon EC2 User Guide. // - // price-capacity-optimized (recommended) - // - // EC2 Fleet identifies the pools with the highest capacity availability for - // the number of instances that are launching. This means that we will request - // Spot Instances from the pools that we believe have the lowest chance of interruption - // in the near term. EC2 Fleet then requests Spot Instances from the lowest - // priced of these pools. - // - // capacity-optimized - // - // EC2 Fleet identifies the pools with the highest capacity availability for - // the number of instances that are launching. This means that we will request - // Spot Instances from the pools that we believe have the lowest chance of interruption - // in the near term. To give certain instance types a higher chance of launching - // first, use capacity-optimized-prioritized. Set a priority for each instance - // type by using the Priority parameter for LaunchTemplateOverrides. You can - // assign the same priority to different LaunchTemplateOverrides. EC2 implements - // the priorities on a best-effort basis, but optimizes for capacity first. - // capacity-optimized-prioritized is supported only if your EC2 Fleet uses a - // launch template. Note that if the On-Demand AllocationStrategy is set to - // prioritized, the same priority is applied when fulfilling On-Demand capacity. - // - // diversified - // - // EC2 Fleet requests instances from all of the Spot Instance pools that you - // specify. - // - // lowest-price - // - // EC2 Fleet requests instances from the lowest priced Spot Instance pool that - // has available capacity. If the lowest priced pool doesn't have available - // capacity, the Spot Instances come from the next lowest priced pool that has - // available capacity. If a pool runs out of capacity before fulfilling your - // desired capacity, EC2 Fleet will continue to fulfill your request by drawing - // from the next lowest priced pool. To ensure that your desired capacity is - // met, you might receive Spot Instances from several pools. Because this strategy - // only considers instance price and not capacity availability, it might lead - // to high interruption rates. + // lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance + // pool that has available capacity. If the cheapest pool doesn't have available + // capacity, the Spot Instances come from the next cheapest pool that has available + // capacity. If a pool runs out of capacity before fulfilling your desired capacity, + // EC2 Fleet will continue to fulfill your request by drawing from the next + // cheapest pool. To ensure that your desired capacity is met, you might receive + // Spot Instances from several pools. + // + // diversified - EC2 Fleet launches instances from all of the Spot Instance + // pools that you specify. + // + // capacity-optimized (recommended) - EC2 Fleet launches instances from Spot + // Instance pools with optimal capacity for the number of instances that are + // launching. To give certain instance types a higher chance of launching first, + // use capacity-optimized-prioritized. Set a priority for each instance type + // by using the Priority parameter for LaunchTemplateOverrides. You can assign + // the same priority to different LaunchTemplateOverrides. EC2 implements the + // priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized + // is supported only if your fleet uses a launch template. Note that if the + // On-Demand AllocationStrategy is set to prioritized, the same priority is + // applied when fulfilling On-Demand capacity. // // Default: lowest-price AllocationStrategy *string `type:"string" enum:"SpotAllocationStrategy"` diff --git a/service/elbv2/api.go b/service/elbv2/api.go index 5f572a841f3..74b09dec696 100644 --- a/service/elbv2/api.go +++ b/service/elbv2/api.go @@ -2655,9 +2655,6 @@ func (c *ELBV2) ModifyTargetGroupRequest(input *ModifyTargetGroupInput) (req *re // Modifies the health checks used when evaluating the health state of the targets // in the specified target group. // -// If the protocol of the target group is TCP, TLS, UDP, or TCP_UDP, you can't -// modify the health check protocol, interval, timeout, or success codes. -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4805,11 +4802,10 @@ type CreateTargetGroupInput struct { HealthCheckEnabled *bool `type:"boolean"` // The approximate amount of time, in seconds, between health checks of an individual - // target. If the target group protocol is HTTP or HTTPS, the default is 30 - // seconds. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported - // values are 10 and 30 seconds and the default is 30 seconds. If the target - // group protocol is GENEVE, the default is 10 seconds. If the target type is - // lambda, the default is 35 seconds. + // target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, + // TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol + // is GENEVE, the default is 10 seconds. If the target type is lambda, the default + // is 35 seconds. HealthCheckIntervalSeconds *int64 `min:"5" type:"integer"` // [HTTP/HTTPS health checks] The destination for health checks on the targets. @@ -4834,17 +4830,18 @@ type CreateTargetGroupInput struct { HealthCheckProtocol *string `type:"string" enum:"ProtocolEnum"` // The amount of time, in seconds, during which no response from a target means - // a failed health check. For target groups with a protocol of HTTP, HTTPS, - // or GENEVE, the default is 5 seconds. For target groups with a protocol of - // TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds - // for TCP and HTTPS health checks. If the target type is lambda, the default - // is 30 seconds. + // a failed health check. The range is 2–120 seconds. For target groups with + // a protocol of HTTP, the default is 6 seconds. For target groups with a protocol + // of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a + // protocol of GENEVE, the default is 5 seconds. If the target type is lambda, + // the default is 30 seconds. HealthCheckTimeoutSeconds *int64 `min:"2" type:"integer"` - // The number of consecutive health checks successes required before considering - // an unhealthy target healthy. For target groups with a protocol of HTTP or - // HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or - // GENEVE, the default is 3. If the target type is lambda, the default is 5. + // The number of consecutive health check successes required before considering + // a target healthy. The range is 2-10. If the target group protocol is TCP, + // TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with + // a protocol of GENEVE, the default is 3. If the target type is lambda, the + // default is 5. HealthyThresholdCount *int64 `min:"2" type:"integer"` // The type of IP address used for this target group. The possible values are @@ -4853,7 +4850,10 @@ type CreateTargetGroupInput struct { IpAddressType *string `type:"string" enum:"TargetGroupIpAddressTypeEnum"` // [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for - // a successful response from a target. + // a successful response from a target. For target groups with a protocol of + // TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol + // of HTTP or HTTPS, the range is 200-499. For target groups with a protocol + // of GENEVE, the range is 200-399. Matcher *Matcher `type:"structure"` // The name of the target group. @@ -4905,10 +4905,10 @@ type CreateTargetGroupInput struct { TargetType *string `type:"string" enum:"TargetTypeEnum"` // The number of consecutive health check failures required before considering - // a target unhealthy. If the target group protocol is HTTP or HTTPS, the default - // is 2. If the target group protocol is TCP or TLS, this value must be the - // same as the healthy threshold count. If the target group protocol is GENEVE, - // the default is 3. If the target type is lambda, the default is 2. + // a target unhealthy. The range is 2-10. If the target group protocol is TCP, + // TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with + // a protocol of GENEVE, the default is 3. If the target type is lambda, the + // default is 5. UnhealthyThresholdCount *int64 `min:"2" type:"integer"` // The identifier of the virtual private cloud (VPC). If the target is a Lambda @@ -6659,8 +6659,8 @@ type ForwardActionConfig struct { // The target group stickiness for the rule. TargetGroupStickinessConfig *TargetGroupStickinessConfig `type:"structure"` - // One or more target groups. For Network Load Balancers, you can specify a - // single target group. + // The target groups. For Network Load Balancers, you can specify a single target + // group. TargetGroups []*TargetGroupTuple `type:"list"` } @@ -6698,9 +6698,9 @@ func (s *ForwardActionConfig) SetTargetGroups(v []*TargetGroupTuple) *ForwardAct type HostHeaderConditionConfig struct { _ struct{} `type:"structure"` - // One or more host names. The maximum size of each name is 128 characters. - // The comparison is case insensitive. The following wildcard characters are - // supported: * (matches 0 or more characters) and ? (matches exactly 1 character). + // The host names. The maximum size of each name is 128 characters. The comparison + // is case insensitive. The following wildcard characters are supported: * (matches + // 0 or more characters) and ? (matches exactly 1 character). // // If you specify multiple strings, the condition is satisfied if one of the // strings matches the host name. @@ -6746,10 +6746,10 @@ type HttpHeaderConditionConfig struct { // to specify a host header condition. HttpHeaderName *string `type:"string"` - // One or more strings to compare against the value of the HTTP header. The - // maximum size of each string is 128 characters. The comparison strings are - // case insensitive. The following wildcard characters are supported: * (matches - // 0 or more characters) and ? (matches exactly 1 character). + // The strings to compare against the value of the HTTP header. The maximum + // size of each string is 128 characters. The comparison strings are case insensitive. + // The following wildcard characters are supported: * (matches 0 or more characters) + // and ? (matches exactly 1 character). // // If the same header appears multiple times in the request, we search them // in order until a match is found. @@ -7226,11 +7226,16 @@ type LoadBalancerAttribute struct { // The name of the attribute. // - // The following attribute is supported by all load balancers: + // The following attributes are supported by all load balancers: // // * deletion_protection.enabled - Indicates whether deletion protection // is enabled. The value is true or false. The default is false. // + // * load_balancing.cross_zone.enabled - Indicates whether cross-zone load + // balancing is enabled. The possible values are true and false. The default + // for Network Load Balancers and Gateway Load Balancers is false. The default + // for Application Load Balancers is true, and cannot be changed. + // // The following attributes are supported by both Application Load Balancers // and Network Load Balancers: // @@ -7305,13 +7310,6 @@ type LoadBalancerAttribute struct { // balancer to route requests to targets if it is unable to forward the request // to Amazon Web Services WAF. The possible values are true and false. The // default is false. - // - // The following attribute is supported by Network Load Balancers and Gateway - // Load Balancers: - // - // * load_balancing.cross_zone.enabled - Indicates whether cross-zone load - // balancing is enabled. The possible values are true and false. The default - // is false. Key *string `type:"string"` // The value of the attribute. @@ -7405,10 +7403,14 @@ type Matcher struct { GrpcCode *string `type:"string"` // For Application Load Balancers, you can specify values between 200 and 499, - // and the default value is 200. You can specify multiple values (for example, + // with the default value being 200. You can specify multiple values (for example, + // "200,202") or a range of values (for example, "200-299"). + // + // For Network Load Balancers, you can specify values between 200 and 599, with + // the default value being 200-399. You can specify multiple values (for example, // "200,202") or a range of values (for example, "200-299"). // - // For Network Load Balancers and Gateway Load Balancers, this must be "200–399". + // For Gateway Load Balancers, this must be "200–399". // // Note that when using shorthand syntax, some values such as commas need to // be escaped. @@ -7909,7 +7911,7 @@ type ModifyTargetGroupInput struct { HealthCheckEnabled *bool `type:"boolean"` // The approximate amount of time, in seconds, between health checks of an individual - // target. For TCP health checks, the supported values are 10 or 30 seconds. + // target. HealthCheckIntervalSeconds *int64 `min:"5" type:"integer"` // [HTTP/HTTPS health checks] The destination for health checks on the targets. @@ -7941,7 +7943,10 @@ type ModifyTargetGroupInput struct { HealthyThresholdCount *int64 `min:"2" type:"integer"` // [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for - // a successful response from a target. + // a successful response from a target. For target groups with a protocol of + // TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol + // of HTTP or HTTPS, the range is 200-499. For target groups with a protocol + // of GENEVE, the range is 200-399. Matcher *Matcher `type:"structure"` // The Amazon Resource Name (ARN) of the target group. @@ -7950,8 +7955,7 @@ type ModifyTargetGroupInput struct { TargetGroupArn *string `type:"string" required:"true"` // The number of consecutive health check failures required before considering - // the target unhealthy. For target groups with a protocol of TCP or TLS, this - // value must be the same as the healthy threshold count. + // the target unhealthy. UnhealthyThresholdCount *int64 `min:"2" type:"integer"` } @@ -8096,10 +8100,10 @@ func (s *ModifyTargetGroupOutput) SetTargetGroups(v []*TargetGroup) *ModifyTarge type PathPatternConditionConfig struct { _ struct{} `type:"structure"` - // One or more path patterns to compare against the request URL. The maximum - // size of each string is 128 characters. The comparison is case sensitive. - // The following wildcard characters are supported: * (matches 0 or more characters) - // and ? (matches exactly 1 character). + // The path patterns to compare against the request URL. The maximum size of + // each string is 128 characters. The comparison is case sensitive. The following + // wildcard characters are supported: * (matches 0 or more characters) and ? + // (matches exactly 1 character). // // If you specify multiple strings, the condition is satisfied if one of them // matches the request URL. The path pattern is compared only to the path of @@ -8141,9 +8145,9 @@ func (s *PathPatternConditionConfig) SetValues(v []*string) *PathPatternConditio type QueryStringConditionConfig struct { _ struct{} `type:"structure"` - // One or more key/value pairs or values to find in the query string. The maximum - // size of each string is 128 characters. The comparison is case insensitive. - // The following wildcard characters are supported: * (matches 0 or more characters) + // The key/value pairs or values to find in the query string. The maximum size + // of each string is 128 characters. The comparison is case insensitive. The + // following wildcard characters are supported: * (matches 0 or more characters) // and ? (matches exactly 1 character). To search for a literal '*' or '?' character // in a query string, you must escape these characters in Values using a '\' // character. @@ -9292,8 +9296,8 @@ func (s *SetSubnetsOutput) SetIpAddressType(v string) *SetSubnetsOutput { type SourceIpConditionConfig struct { _ struct{} `type:"structure"` - // One or more source IP addresses, in CIDR format. You can use both IPv4 and - // IPv6 addresses. Wildcards are not supported. + // The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. + // Wildcards are not supported. // // If you specify multiple addresses, the condition is satisfied if the source // IP address of the request matches one of the CIDR blocks. This condition @@ -9553,6 +9557,10 @@ type TargetDescription struct { // traffic from the load balancer nodes in the specified Availability Zone or // from all enabled Availability Zones for the load balancer. // + // For Application Load Balancer target groups, the specified Availability Zone + // value is only applicable when cross-zone load balancing is off. Otherwise + // the parameter is ignored and treated as all. + // // This parameter is not supported if the target type of the target group is // instance or alb. // @@ -9561,8 +9569,10 @@ type TargetDescription struct { // parameter is optional. If the IP address is outside the VPC, this parameter // is required. // - // With an Application Load Balancer, if the target type is ip and the IP address - // is outside the VPC for the target group, the only supported value is all. + // For Application Load Balancer target groups with cross-zone load balancing + // off, if the target type is ip and the IP address is outside of the VPC for + // the target group, this should be an Availability Zone inside the VPC for + // the target group. // // If the target type is lambda, this parameter is optional and the only supported // value is all. @@ -9842,7 +9852,7 @@ type TargetGroupAttribute struct { // The name of the attribute. // - // The following attribute is supported by all load balancers: + // The following attributes are supported by all load balancers: // // * deregistration_delay.timeout_seconds - The amount of time, in seconds, // for Elastic Load Balancing to wait before changing the state of a deregistering @@ -9850,9 +9860,6 @@ type TargetGroupAttribute struct { // value is 300 seconds. If the target is a Lambda function, this attribute // is not supported. // - // The following attributes are supported by Application Load Balancers, Network - // Load Balancers, and Gateway Load Balancers: - // // * stickiness.enabled - Indicates whether target stickiness is enabled. // The value is true or false. The default is false. // @@ -9861,6 +9868,37 @@ type TargetGroupAttribute struct { // for Network Load Balancers. source_ip_dest_ip and source_ip_dest_ip_proto // for Gateway Load Balancers. // + // The following attributes are supported by Application Load Balancers and + // Network Load Balancers: + // + // * load_balancing.cross_zone.enabled - Indicates whether cross zone load + // balancing is enabled. The value is true, false or use_load_balancer_configuration. + // The default is use_load_balancer_configuration. + // + // * target_group_health.dns_failover.minimum_healthy_targets.count - The + // minimum number of targets that must be healthy. If the number of healthy + // targets is below this value, mark the zone as unhealthy in DNS, so that + // traffic is routed only to healthy zones. The possible values are off or + // an integer from 1 to the maximum number of targets. The default is off. + // + // * target_group_health.dns_failover.minimum_healthy_targets.percentage + // - The minimum percentage of targets that must be healthy. If the percentage + // of healthy targets is below this value, mark the zone as unhealthy in + // DNS, so that traffic is routed only to healthy zones. The possible values + // are off or an integer from 1 to 100. The default is off. + // + // * target_group_health.unhealthy_state_routing.minimum_healthy_targets.count + // - The minimum number of targets that must be healthy. If the number of + // healthy targets is below this value, send traffic to all targets, including + // unhealthy targets. The possible values are 1 to the maximum number of + // targets. The default is 1. + // + // * target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage + // - The minimum percentage of targets that must be healthy. If the percentage + // of healthy targets is below this value, send traffic to all targets, including + // unhealthy targets. The possible values are off or an integer from 1 to + // 100. The default is off. + // // The following attributes are supported only if the load balancer is an Application // Load Balancer and the target is an instance or an IP address: // diff --git a/service/emrserverless/api.go b/service/emrserverless/api.go index db9dd7cdb91..49a6e9bbe24 100644 --- a/service/emrserverless/api.go +++ b/service/emrserverless/api.go @@ -1428,6 +1428,9 @@ type Application struct { // ApplicationId is a required field ApplicationId *string `locationName:"applicationId" min:"1" type:"string" required:"true"` + // The CPU architecture of an application. + Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` + // The ARN of the application. // // Arn is a required field @@ -1510,6 +1513,12 @@ func (s *Application) SetApplicationId(v string) *Application { return s } +// SetArchitecture sets the Architecture field's value. +func (s *Application) SetArchitecture(v string) *Application { + s.Architecture = &v + return s +} + // SetArn sets the Arn field's value. func (s *Application) SetArn(v string) *Application { s.Arn = &v @@ -1598,6 +1607,9 @@ func (s *Application) SetUpdatedAt(v time.Time) *Application { type ApplicationSummary struct { _ struct{} `type:"structure"` + // The CPU architecture of an application. + Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` + // The ARN of the application. // // Arn is a required field @@ -1658,6 +1670,12 @@ func (s ApplicationSummary) GoString() string { return s.String() } +// SetArchitecture sets the Architecture field's value. +func (s *ApplicationSummary) SetArchitecture(v string) *ApplicationSummary { + s.Architecture = &v + return s +} + // SetArn sets the Arn field's value. func (s *ApplicationSummary) SetArn(v string) *ApplicationSummary { s.Arn = &v @@ -2131,6 +2149,9 @@ func (s *ConflictException) RequestID() string { type CreateApplicationInput struct { _ struct{} `type:"structure"` + // The CPU architecture of an application. + Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` + // The configuration for an application to automatically start on job submission. AutoStartConfiguration *AutoStartConfig `locationName:"autoStartConfiguration" type:"structure"` @@ -2237,6 +2258,12 @@ func (s *CreateApplicationInput) Validate() error { return nil } +// SetArchitecture sets the Architecture field's value. +func (s *CreateApplicationInput) SetArchitecture(v string) *CreateApplicationInput { + s.Architecture = &v + return s +} + // SetAutoStartConfiguration sets the AutoStartConfiguration field's value. func (s *CreateApplicationInput) SetAutoStartConfiguration(v *AutoStartConfig) *CreateApplicationInput { s.AutoStartConfiguration = v @@ -4746,6 +4773,9 @@ type UpdateApplicationInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"1" type:"string" required:"true"` + // The CPU architecture of an application. + Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` + // The configuration for an application to automatically start on job submission. AutoStartConfiguration *AutoStartConfig `locationName:"autoStartConfiguration" type:"structure"` @@ -4833,6 +4863,12 @@ func (s *UpdateApplicationInput) SetApplicationId(v string) *UpdateApplicationIn return s } +// SetArchitecture sets the Architecture field's value. +func (s *UpdateApplicationInput) SetArchitecture(v string) *UpdateApplicationInput { + s.Architecture = &v + return s +} + // SetAutoStartConfiguration sets the AutoStartConfiguration field's value. func (s *UpdateApplicationInput) SetAutoStartConfiguration(v *AutoStartConfig) *UpdateApplicationInput { s.AutoStartConfiguration = v @@ -5082,6 +5118,22 @@ func ApplicationState_Values() []string { } } +const ( + // ArchitectureArm64 is a Architecture enum value + ArchitectureArm64 = "ARM64" + + // ArchitectureX8664 is a Architecture enum value + ArchitectureX8664 = "X86_64" +) + +// Architecture_Values returns all elements of the Architecture enum +func Architecture_Values() []string { + return []string{ + ArchitectureArm64, + ArchitectureX8664, + } +} + const ( // JobRunStateSubmitted is a JobRunState enum value JobRunStateSubmitted = "SUBMITTED" diff --git a/service/ivschat/api.go b/service/ivschat/api.go index 3523285a492..031e5bd0085 100644 --- a/service/ivschat/api.go +++ b/service/ivschat/api.go @@ -56,9 +56,20 @@ func (c *Ivschat) CreateChatTokenRequest(input *CreateChatTokenInput) (req *requ // CreateChatToken API operation for Amazon Interactive Video Service Chat. // -// Creates an encrypted token that is used to establish an individual WebSocket -// connection to a room. The token is valid for one minute, and a connection -// (session) established with the token is valid for the specified duration. +// Creates an encrypted token that is used by a chat participant to establish +// an individual WebSocket chat connection to a room. When the token is used +// to connect to chat, the connection is valid for the session duration specified +// in the request. The token becomes invalid at the token-expiration timestamp +// included in the response. +// +// Use the capabilities field to permit an end user to send messages or moderate +// a room. +// +// The attributes field securely attaches structured data to the chat session; +// the data is included within each message sent by the end user and received +// by other participants in the room. Common use cases for attributes include +// passing end-user profile data like an icon, display name, colors, badges, +// and other display features. // // Encryption keys are owned by Amazon IVS Chat and never used directly by your // application. @@ -102,6 +113,95 @@ func (c *Ivschat) CreateChatTokenWithContext(ctx aws.Context, input *CreateChatT return out, req.Send() } +const opCreateLoggingConfiguration = "CreateLoggingConfiguration" + +// CreateLoggingConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the CreateLoggingConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateLoggingConfiguration for more information on using the CreateLoggingConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateLoggingConfigurationRequest method. +// req, resp := client.CreateLoggingConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfiguration +func (c *Ivschat) CreateLoggingConfigurationRequest(input *CreateLoggingConfigurationInput) (req *request.Request, output *CreateLoggingConfigurationOutput) { + op := &request.Operation{ + Name: opCreateLoggingConfiguration, + HTTPMethod: "POST", + HTTPPath: "/CreateLoggingConfiguration", + } + + if input == nil { + input = &CreateLoggingConfigurationInput{} + } + + output = &CreateLoggingConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateLoggingConfiguration API operation for Amazon Interactive Video Service Chat. +// +// Creates a logging configuration that allows clients to store and record sent +// messages. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service Chat's +// API operation CreateLoggingConfiguration for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// +// - AccessDeniedException +// +// - ResourceNotFoundException +// +// - ServiceQuotaExceededException +// +// - PendingVerification +// +// - ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfiguration +func (c *Ivschat) CreateLoggingConfiguration(input *CreateLoggingConfigurationInput) (*CreateLoggingConfigurationOutput, error) { + req, out := c.CreateLoggingConfigurationRequest(input) + return out, req.Send() +} + +// CreateLoggingConfigurationWithContext is the same as CreateLoggingConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See CreateLoggingConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Ivschat) CreateLoggingConfigurationWithContext(ctx aws.Context, input *CreateLoggingConfigurationInput, opts ...request.Option) (*CreateLoggingConfigurationOutput, error) { + req, out := c.CreateLoggingConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateRoom = "CreateRoom" // CreateRoomRequest generates a "aws/request.Request" representing the @@ -190,6 +290,93 @@ func (c *Ivschat) CreateRoomWithContext(ctx aws.Context, input *CreateRoomInput, return out, req.Send() } +const opDeleteLoggingConfiguration = "DeleteLoggingConfiguration" + +// DeleteLoggingConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteLoggingConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteLoggingConfiguration for more information on using the DeleteLoggingConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteLoggingConfigurationRequest method. +// req, resp := client.DeleteLoggingConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteLoggingConfiguration +func (c *Ivschat) DeleteLoggingConfigurationRequest(input *DeleteLoggingConfigurationInput) (req *request.Request, output *DeleteLoggingConfigurationOutput) { + op := &request.Operation{ + Name: opDeleteLoggingConfiguration, + HTTPMethod: "POST", + HTTPPath: "/DeleteLoggingConfiguration", + } + + if input == nil { + input = &DeleteLoggingConfigurationInput{} + } + + output = &DeleteLoggingConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteLoggingConfiguration API operation for Amazon Interactive Video Service Chat. +// +// Deletes the specified logging configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service Chat's +// API operation DeleteLoggingConfiguration for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// +// - AccessDeniedException +// +// - ResourceNotFoundException +// +// - PendingVerification +// +// - ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteLoggingConfiguration +func (c *Ivschat) DeleteLoggingConfiguration(input *DeleteLoggingConfigurationInput) (*DeleteLoggingConfigurationOutput, error) { + req, out := c.DeleteLoggingConfigurationRequest(input) + return out, req.Send() +} + +// DeleteLoggingConfigurationWithContext is the same as DeleteLoggingConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteLoggingConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Ivschat) DeleteLoggingConfigurationWithContext(ctx aws.Context, input *DeleteLoggingConfigurationInput, opts ...request.Option) (*DeleteLoggingConfigurationOutput, error) { + req, out := c.DeleteLoggingConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteMessage = "DeleteMessage" // DeleteMessageRequest generates a "aws/request.Request" representing the @@ -450,6 +637,88 @@ func (c *Ivschat) DisconnectUserWithContext(ctx aws.Context, input *DisconnectUs return out, req.Send() } +const opGetLoggingConfiguration = "GetLoggingConfiguration" + +// GetLoggingConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the GetLoggingConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetLoggingConfiguration for more information on using the GetLoggingConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetLoggingConfigurationRequest method. +// req, resp := client.GetLoggingConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfiguration +func (c *Ivschat) GetLoggingConfigurationRequest(input *GetLoggingConfigurationInput) (req *request.Request, output *GetLoggingConfigurationOutput) { + op := &request.Operation{ + Name: opGetLoggingConfiguration, + HTTPMethod: "POST", + HTTPPath: "/GetLoggingConfiguration", + } + + if input == nil { + input = &GetLoggingConfigurationInput{} + } + + output = &GetLoggingConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetLoggingConfiguration API operation for Amazon Interactive Video Service Chat. +// +// Gets the specified logging configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service Chat's +// API operation GetLoggingConfiguration for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// +// - ResourceNotFoundException +// +// - ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfiguration +func (c *Ivschat) GetLoggingConfiguration(input *GetLoggingConfigurationInput) (*GetLoggingConfigurationOutput, error) { + req, out := c.GetLoggingConfigurationRequest(input) + return out, req.Send() +} + +// GetLoggingConfigurationWithContext is the same as GetLoggingConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See GetLoggingConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Ivschat) GetLoggingConfigurationWithContext(ctx aws.Context, input *GetLoggingConfigurationInput, opts ...request.Option) (*GetLoggingConfigurationOutput, error) { + req, out := c.GetLoggingConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetRoom = "GetRoom" // GetRoomRequest generates a "aws/request.Request" representing the @@ -532,36 +801,36 @@ func (c *Ivschat) GetRoomWithContext(ctx aws.Context, input *GetRoomInput, opts return out, req.Send() } -const opListRooms = "ListRooms" +const opListLoggingConfigurations = "ListLoggingConfigurations" -// ListRoomsRequest generates a "aws/request.Request" representing the -// client's request for the ListRooms operation. The "output" return +// ListLoggingConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListLoggingConfigurations operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListRooms for more information on using the ListRooms +// See ListLoggingConfigurations for more information on using the ListLoggingConfigurations // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListRoomsRequest method. -// req, resp := client.ListRoomsRequest(params) +// // Example sending a request using the ListLoggingConfigurationsRequest method. +// req, resp := client.ListLoggingConfigurationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRooms -func (c *Ivschat) ListRoomsRequest(input *ListRoomsInput) (req *request.Request, output *ListRoomsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurations +func (c *Ivschat) ListLoggingConfigurationsRequest(input *ListLoggingConfigurationsInput) (req *request.Request, output *ListLoggingConfigurationsOutput) { op := &request.Operation{ - Name: opListRooms, + Name: opListLoggingConfigurations, HTTPMethod: "POST", - HTTPPath: "/ListRooms", + HTTPPath: "/ListLoggingConfigurations", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -571,92 +840,90 @@ func (c *Ivschat) ListRoomsRequest(input *ListRoomsInput) (req *request.Request, } if input == nil { - input = &ListRoomsInput{} + input = &ListLoggingConfigurationsInput{} } - output = &ListRoomsOutput{} + output = &ListLoggingConfigurationsOutput{} req = c.newRequest(op, input, output) return } -// ListRooms API operation for Amazon Interactive Video Service Chat. +// ListLoggingConfigurations API operation for Amazon Interactive Video Service Chat. // -// Gets summary information about all your rooms in the AWS region where the -// API request is processed. Results are sorted in descending order of updateTime. +// Gets summary information about all your logging configurations in the AWS +// region where the API request is processed. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Interactive Video Service Chat's -// API operation ListRooms for usage and error information. +// API operation ListLoggingConfigurations for usage and error information. // // Returned Error Types: // // - AccessDeniedException // -// - ResourceNotFoundException -// // - ValidationException // -// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRooms -func (c *Ivschat) ListRooms(input *ListRoomsInput) (*ListRoomsOutput, error) { - req, out := c.ListRoomsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurations +func (c *Ivschat) ListLoggingConfigurations(input *ListLoggingConfigurationsInput) (*ListLoggingConfigurationsOutput, error) { + req, out := c.ListLoggingConfigurationsRequest(input) return out, req.Send() } -// ListRoomsWithContext is the same as ListRooms with the addition of +// ListLoggingConfigurationsWithContext is the same as ListLoggingConfigurations with the addition of // the ability to pass a context and additional request options. // -// See ListRooms for details on how to use this API operation. +// See ListLoggingConfigurations for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Ivschat) ListRoomsWithContext(ctx aws.Context, input *ListRoomsInput, opts ...request.Option) (*ListRoomsOutput, error) { - req, out := c.ListRoomsRequest(input) +func (c *Ivschat) ListLoggingConfigurationsWithContext(ctx aws.Context, input *ListLoggingConfigurationsInput, opts ...request.Option) (*ListLoggingConfigurationsOutput, error) { + req, out := c.ListLoggingConfigurationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListRoomsPages iterates over the pages of a ListRooms operation, +// ListLoggingConfigurationsPages iterates over the pages of a ListLoggingConfigurations operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListRooms method for more information on how to use this operation. +// See ListLoggingConfigurations method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListRooms operation. +// // Example iterating over at most 3 pages of a ListLoggingConfigurations operation. // pageNum := 0 -// err := client.ListRoomsPages(params, -// func(page *ivschat.ListRoomsOutput, lastPage bool) bool { +// err := client.ListLoggingConfigurationsPages(params, +// func(page *ivschat.ListLoggingConfigurationsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Ivschat) ListRoomsPages(input *ListRoomsInput, fn func(*ListRoomsOutput, bool) bool) error { - return c.ListRoomsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Ivschat) ListLoggingConfigurationsPages(input *ListLoggingConfigurationsInput, fn func(*ListLoggingConfigurationsOutput, bool) bool) error { + return c.ListLoggingConfigurationsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListRoomsPagesWithContext same as ListRoomsPages except +// ListLoggingConfigurationsPagesWithContext same as ListLoggingConfigurationsPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Ivschat) ListRoomsPagesWithContext(ctx aws.Context, input *ListRoomsInput, fn func(*ListRoomsOutput, bool) bool, opts ...request.Option) error { +func (c *Ivschat) ListLoggingConfigurationsPagesWithContext(ctx aws.Context, input *ListLoggingConfigurationsInput, fn func(*ListLoggingConfigurationsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListRoomsInput + var inCpy *ListLoggingConfigurationsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListRoomsRequest(inCpy) + req, _ := c.ListLoggingConfigurationsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -664,7 +931,7 @@ func (c *Ivschat) ListRoomsPagesWithContext(ctx aws.Context, input *ListRoomsInp } for p.Next() { - if !fn(p.Page().(*ListRoomsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListLoggingConfigurationsOutput), !p.HasNextPage()) { break } } @@ -672,43 +939,183 @@ func (c *Ivschat) ListRoomsPagesWithContext(ctx aws.Context, input *ListRoomsInp return p.Err() } -const opListTagsForResource = "ListTagsForResource" +const opListRooms = "ListRooms" -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource operation. The "output" return +// ListRoomsRequest generates a "aws/request.Request" representing the +// client's request for the ListRooms operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListTagsForResource for more information on using the ListTagsForResource +// See ListRooms for more information on using the ListRooms // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(params) +// // Example sending a request using the ListRoomsRequest method. +// req, resp := client.ListRoomsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListTagsForResource -func (c *Ivschat) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRooms +func (c *Ivschat) ListRoomsRequest(input *ListRoomsInput) (req *request.Request, output *ListRoomsOutput) { op := &request.Operation{ - Name: opListTagsForResource, - HTTPMethod: "GET", - HTTPPath: "/tags/{resourceArn}", - } - - if input == nil { - input = &ListTagsForResourceInput{} - } - - output = &ListTagsForResourceOutput{} + Name: opListRooms, + HTTPMethod: "POST", + HTTPPath: "/ListRooms", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListRoomsInput{} + } + + output = &ListRoomsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListRooms API operation for Amazon Interactive Video Service Chat. +// +// Gets summary information about all your rooms in the AWS region where the +// API request is processed. Results are sorted in descending order of updateTime. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service Chat's +// API operation ListRooms for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// +// - ResourceNotFoundException +// +// - ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRooms +func (c *Ivschat) ListRooms(input *ListRoomsInput) (*ListRoomsOutput, error) { + req, out := c.ListRoomsRequest(input) + return out, req.Send() +} + +// ListRoomsWithContext is the same as ListRooms with the addition of +// the ability to pass a context and additional request options. +// +// See ListRooms for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Ivschat) ListRoomsWithContext(ctx aws.Context, input *ListRoomsInput, opts ...request.Option) (*ListRoomsOutput, error) { + req, out := c.ListRoomsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListRoomsPages iterates over the pages of a ListRooms operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRooms method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListRooms operation. +// pageNum := 0 +// err := client.ListRoomsPages(params, +// func(page *ivschat.ListRoomsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Ivschat) ListRoomsPages(input *ListRoomsInput, fn func(*ListRoomsOutput, bool) bool) error { + return c.ListRoomsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRoomsPagesWithContext same as ListRoomsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Ivschat) ListRoomsPagesWithContext(ctx aws.Context, input *ListRoomsInput, fn func(*ListRoomsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRoomsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRoomsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRoomsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListTagsForResource +func (c *Ivschat) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} req = c.newRequest(op, input, output) return } @@ -1006,6 +1413,90 @@ func (c *Ivschat) UntagResourceWithContext(ctx aws.Context, input *UntagResource return out, req.Send() } +const opUpdateLoggingConfiguration = "UpdateLoggingConfiguration" + +// UpdateLoggingConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateLoggingConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateLoggingConfiguration for more information on using the UpdateLoggingConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateLoggingConfigurationRequest method. +// req, resp := client.UpdateLoggingConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfiguration +func (c *Ivschat) UpdateLoggingConfigurationRequest(input *UpdateLoggingConfigurationInput) (req *request.Request, output *UpdateLoggingConfigurationOutput) { + op := &request.Operation{ + Name: opUpdateLoggingConfiguration, + HTTPMethod: "POST", + HTTPPath: "/UpdateLoggingConfiguration", + } + + if input == nil { + input = &UpdateLoggingConfigurationInput{} + } + + output = &UpdateLoggingConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateLoggingConfiguration API operation for Amazon Interactive Video Service Chat. +// +// Updates a specified logging configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service Chat's +// API operation UpdateLoggingConfiguration for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// +// - ResourceNotFoundException +// +// - PendingVerification +// +// - ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfiguration +func (c *Ivschat) UpdateLoggingConfiguration(input *UpdateLoggingConfigurationInput) (*UpdateLoggingConfigurationOutput, error) { + req, out := c.UpdateLoggingConfigurationRequest(input) + return out, req.Send() +} + +// UpdateLoggingConfigurationWithContext is the same as UpdateLoggingConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateLoggingConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Ivschat) UpdateLoggingConfigurationWithContext(ctx aws.Context, input *UpdateLoggingConfigurationInput, opts ...request.Option) (*UpdateLoggingConfigurationOutput, error) { + req, out := c.UpdateLoggingConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateRoom = "UpdateRoom" // UpdateRoomRequest generates a "aws/request.Request" representing the @@ -1153,6 +1644,57 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +// Specifies a CloudWatch Logs location where chat logs will be stored. +type CloudWatchLogsDestinationConfiguration struct { + _ struct{} `type:"structure"` + + // Name of the Amazon Cloudwatch Logs destination where chat activity will be + // logged. + // + // LogGroupName is a required field + LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CloudWatchLogsDestinationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CloudWatchLogsDestinationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CloudWatchLogsDestinationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CloudWatchLogsDestinationConfiguration"} + if s.LogGroupName == nil { + invalidParams.Add(request.NewErrParamRequired("LogGroupName")) + } + if s.LogGroupName != nil && len(*s.LogGroupName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LogGroupName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLogGroupName sets the LogGroupName field's value. +func (s *CloudWatchLogsDestinationConfiguration) SetLogGroupName(v string) *CloudWatchLogsDestinationConfiguration { + s.LogGroupName = &v + return s +} + type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -1376,17 +1918,196 @@ func (s *CreateChatTokenOutput) SetTokenExpirationTime(v time.Time) *CreateChatT return s } -type CreateRoomInput struct { +type CreateLoggingConfigurationInput struct { _ struct{} `type:"structure"` - // Maximum number of characters in a single message. Messages are expected to - // be UTF-8 encoded and this limit applies specifically to rune/code-point count, - // not number of bytes. Default: 500. - MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"` + // A complex type that contains a destination configuration for where chat content + // will be logged. There can be only one type of destination (cloudWatchLogs, + // firehose, or s3) in a destinationConfiguration. + // + // DestinationConfiguration is a required field + DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"` - // Maximum number of messages per second that can be sent to the room (by all - // clients). Default: 10. - MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"` + // Logging-configuration name. The value does not need to be unique. + Name *string `locationName:"name" type:"string"` + + // Tags to attach to the resource. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints on tags beyond what + // is documented there. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLoggingConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLoggingConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateLoggingConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateLoggingConfigurationInput"} + if s.DestinationConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationConfiguration")) + } + if s.DestinationConfiguration != nil { + if err := s.DestinationConfiguration.Validate(); err != nil { + invalidParams.AddNested("DestinationConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestinationConfiguration sets the DestinationConfiguration field's value. +func (s *CreateLoggingConfigurationInput) SetDestinationConfiguration(v *DestinationConfiguration) *CreateLoggingConfigurationInput { + s.DestinationConfiguration = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateLoggingConfigurationInput) SetName(v string) *CreateLoggingConfigurationInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateLoggingConfigurationInput) SetTags(v map[string]*string) *CreateLoggingConfigurationInput { + s.Tags = v + return s +} + +type CreateLoggingConfigurationOutput struct { + _ struct{} `type:"structure"` + + // Logging-configuration ARN, assigned by the system. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // Time when the logging configuration was created. This is an ISO 8601 timestamp; + // note that this is returned as a string. + CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"` + + // A complex type that contains a destination configuration for where chat content + // will be logged, from the request. There is only one type of destination (cloudWatchLogs, + // firehose, or s3) in a destinationConfiguration. + DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"` + + // Logging-configuration ID, generated by the system. This is a relative identifier, + // the part of the ARN that uniquely identifies the logging configuration. + Id *string `locationName:"id" min:"12" type:"string"` + + // Logging-configuration name, from the request (if specified). + Name *string `locationName:"name" type:"string"` + + // The state of the logging configuration. When the state is ACTIVE, the configuration + // is ready to log chat content. + State *string `locationName:"state" type:"string" enum:"CreateLoggingConfigurationState"` + + // Tags attached to the resource, from the request (if specified). Array of + // maps, each of the form string:string (key:value). + Tags map[string]*string `locationName:"tags" type:"map"` + + // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; + // note that this is returned as a string. + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLoggingConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLoggingConfigurationOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateLoggingConfigurationOutput) SetArn(v string) *CreateLoggingConfigurationOutput { + s.Arn = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *CreateLoggingConfigurationOutput) SetCreateTime(v time.Time) *CreateLoggingConfigurationOutput { + s.CreateTime = &v + return s +} + +// SetDestinationConfiguration sets the DestinationConfiguration field's value. +func (s *CreateLoggingConfigurationOutput) SetDestinationConfiguration(v *DestinationConfiguration) *CreateLoggingConfigurationOutput { + s.DestinationConfiguration = v + return s +} + +// SetId sets the Id field's value. +func (s *CreateLoggingConfigurationOutput) SetId(v string) *CreateLoggingConfigurationOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateLoggingConfigurationOutput) SetName(v string) *CreateLoggingConfigurationOutput { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *CreateLoggingConfigurationOutput) SetState(v string) *CreateLoggingConfigurationOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateLoggingConfigurationOutput) SetTags(v map[string]*string) *CreateLoggingConfigurationOutput { + s.Tags = v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *CreateLoggingConfigurationOutput) SetUpdateTime(v time.Time) *CreateLoggingConfigurationOutput { + s.UpdateTime = &v + return s +} + +type CreateRoomInput struct { + _ struct{} `type:"structure"` + + // Array of logging-configuration identifiers attached to the room. + LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"` + + // Maximum number of characters in a single message. Messages are expected to + // be UTF-8 encoded and this limit applies specifically to rune/code-point count, + // not number of bytes. Default: 500. + MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"` + + // Maximum number of messages per second that can be sent to the room (by all + // clients). Default: 10. + MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"` // Configuration information for optional review of messages. MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"` @@ -1436,6 +2157,12 @@ func (s *CreateRoomInput) Validate() error { return nil } +// SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value. +func (s *CreateRoomInput) SetLoggingConfigurationIdentifiers(v []*string) *CreateRoomInput { + s.LoggingConfigurationIdentifiers = v + return s +} + // SetMaximumMessageLength sets the MaximumMessageLength field's value. func (s *CreateRoomInput) SetMaximumMessageLength(v int64) *CreateRoomInput { s.MaximumMessageLength = &v @@ -1480,11 +2207,15 @@ type CreateRoomOutput struct { // of the ARN that uniquely identifies the room. Id *string `locationName:"id" min:"12" type:"string"` - // Maximum number of characters in a single message, from the request. + // Array of logging configurations attached to the room, from the request (if + // specified). + LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"` + + // Maximum number of characters in a single message, from the request (if specified). MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"` // Maximum number of messages per second that can be sent to the room (by all - // clients), from the request. + // clients), from the request (if specified). MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"` // Configuration information for optional review of messages. @@ -1493,7 +2224,7 @@ type CreateRoomOutput struct { // Room name, from the request (if specified). Name *string `locationName:"name" type:"string"` - // Tags attached to the resource, from the request. + // Tags attached to the resource, from the request (if specified). Tags map[string]*string `locationName:"tags" type:"map"` // Time of the room’s last update. This is an ISO 8601 timestamp; note that @@ -1537,6 +2268,12 @@ func (s *CreateRoomOutput) SetId(v string) *CreateRoomOutput { return s } +// SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value. +func (s *CreateRoomOutput) SetLoggingConfigurationIdentifiers(v []*string) *CreateRoomOutput { + s.LoggingConfigurationIdentifiers = v + return s +} + // SetMaximumMessageLength sets the MaximumMessageLength field's value. func (s *CreateRoomOutput) SetMaximumMessageLength(v int64) *CreateRoomOutput { s.MaximumMessageLength = &v @@ -1573,6 +2310,77 @@ func (s *CreateRoomOutput) SetUpdateTime(v time.Time) *CreateRoomOutput { return s } +type DeleteLoggingConfigurationInput struct { + _ struct{} `type:"structure"` + + // Identifier of the logging configuration to be deleted. + // + // Identifier is a required field + Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteLoggingConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteLoggingConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteLoggingConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteLoggingConfigurationInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *DeleteLoggingConfigurationInput) SetIdentifier(v string) *DeleteLoggingConfigurationInput { + s.Identifier = &v + return s +} + +type DeleteLoggingConfigurationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteLoggingConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteLoggingConfigurationOutput) GoString() string { + return s.String() +} + type DeleteMessageInput struct { _ struct{} `type:"structure"` @@ -1756,6 +2564,86 @@ func (s DeleteRoomOutput) GoString() string { return s.String() } +// A complex type that describes a location where chat logs will be stored. +// Each member represents the configuration of one log destination. For logging, +// you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, +// or S3). +type DestinationConfiguration struct { + _ struct{} `type:"structure"` + + // Name of the Amazon CloudWatch Logs destination where chat activity will be + // logged. + CloudWatchLogs *CloudWatchLogsDestinationConfiguration `locationName:"cloudWatchLogs" type:"structure"` + + // Name of the Amazon Kinesis Data Firehose destination where chat activity + // will be logged + Firehose *FirehoseDestinationConfiguration `locationName:"firehose" type:"structure"` + + // Name of the Amazon S3 bucket where chat activity will be logged. + S3 *S3DestinationConfiguration `locationName:"s3" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DestinationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DestinationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DestinationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DestinationConfiguration"} + if s.CloudWatchLogs != nil { + if err := s.CloudWatchLogs.Validate(); err != nil { + invalidParams.AddNested("CloudWatchLogs", err.(request.ErrInvalidParams)) + } + } + if s.Firehose != nil { + if err := s.Firehose.Validate(); err != nil { + invalidParams.AddNested("Firehose", err.(request.ErrInvalidParams)) + } + } + if s.S3 != nil { + if err := s.S3.Validate(); err != nil { + invalidParams.AddNested("S3", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudWatchLogs sets the CloudWatchLogs field's value. +func (s *DestinationConfiguration) SetCloudWatchLogs(v *CloudWatchLogsDestinationConfiguration) *DestinationConfiguration { + s.CloudWatchLogs = v + return s +} + +// SetFirehose sets the Firehose field's value. +func (s *DestinationConfiguration) SetFirehose(v *FirehoseDestinationConfiguration) *DestinationConfiguration { + s.Firehose = v + return s +} + +// SetS3 sets the S3 field's value. +func (s *DestinationConfiguration) SetS3(v *S3DestinationConfiguration) *DestinationConfiguration { + s.S3 = v + return s +} + type DisconnectUserInput struct { _ struct{} `type:"structure"` @@ -1857,14 +2745,15 @@ func (s DisconnectUserOutput) GoString() string { return s.String() } -type GetRoomInput struct { +// Specifies a Kinesis Firehose location where chat logs will be stored. +type FirehoseDestinationConfiguration struct { _ struct{} `type:"structure"` - // Identifier of the room for which the configuration is to be retrieved. Currently - // this must be an ARN. + // Name of the Amazon Kinesis Firehose delivery stream where chat activity will + // be logged. // - // Identifier is a required field - Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` + // DeliveryStreamName is a required field + DeliveryStreamName *string `locationName:"deliveryStreamName" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -1872,7 +2761,7 @@ type GetRoomInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetRoomInput) String() string { +func (s FirehoseDestinationConfiguration) String() string { return awsutil.Prettify(s) } @@ -1881,18 +2770,18 @@ func (s GetRoomInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetRoomInput) GoString() string { +func (s FirehoseDestinationConfiguration) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetRoomInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetRoomInput"} - if s.Identifier == nil { - invalidParams.Add(request.NewErrParamRequired("Identifier")) +func (s *FirehoseDestinationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FirehoseDestinationConfiguration"} + if s.DeliveryStreamName == nil { + invalidParams.Add(request.NewErrParamRequired("DeliveryStreamName")) } - if s.Identifier != nil && len(*s.Identifier) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + if s.DeliveryStreamName != nil && len(*s.DeliveryStreamName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeliveryStreamName", 1)) } if invalidParams.Len() > 0 { @@ -1901,8 +2790,208 @@ func (s *GetRoomInput) Validate() error { return nil } -// SetIdentifier sets the Identifier field's value. -func (s *GetRoomInput) SetIdentifier(v string) *GetRoomInput { +// SetDeliveryStreamName sets the DeliveryStreamName field's value. +func (s *FirehoseDestinationConfiguration) SetDeliveryStreamName(v string) *FirehoseDestinationConfiguration { + s.DeliveryStreamName = &v + return s +} + +type GetLoggingConfigurationInput struct { + _ struct{} `type:"structure"` + + // Identifier of the logging configuration to be retrieved. + // + // Identifier is a required field + Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoggingConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoggingConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetLoggingConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetLoggingConfigurationInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *GetLoggingConfigurationInput) SetIdentifier(v string) *GetLoggingConfigurationInput { + s.Identifier = &v + return s +} + +type GetLoggingConfigurationOutput struct { + _ struct{} `type:"structure"` + + // Logging-configuration ARN, from the request (if identifier was an ARN). + Arn *string `locationName:"arn" min:"1" type:"string"` + + // Time when the logging configuration was created. This is an ISO 8601 timestamp; + // note that this is returned as a string. + CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"` + + // A complex type that contains a destination configuration for where chat content + // will be logged. There is only one type of destination (cloudWatchLogs, firehose, + // or s3) in a destinationConfiguration. + DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"` + + // Logging-configuration ID, generated by the system. This is a relative identifier, + // the part of the ARN that uniquely identifies the logging configuration. + Id *string `locationName:"id" min:"12" type:"string"` + + // Logging-configuration name. This value does not need to be unique. + Name *string `locationName:"name" type:"string"` + + // The state of the logging configuration. When the state is ACTIVE, the configuration + // is ready to log chat content. + State *string `locationName:"state" type:"string" enum:"LoggingConfigurationState"` + + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). + Tags map[string]*string `locationName:"tags" type:"map"` + + // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; + // note that this is returned as a string. + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoggingConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoggingConfigurationOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *GetLoggingConfigurationOutput) SetArn(v string) *GetLoggingConfigurationOutput { + s.Arn = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *GetLoggingConfigurationOutput) SetCreateTime(v time.Time) *GetLoggingConfigurationOutput { + s.CreateTime = &v + return s +} + +// SetDestinationConfiguration sets the DestinationConfiguration field's value. +func (s *GetLoggingConfigurationOutput) SetDestinationConfiguration(v *DestinationConfiguration) *GetLoggingConfigurationOutput { + s.DestinationConfiguration = v + return s +} + +// SetId sets the Id field's value. +func (s *GetLoggingConfigurationOutput) SetId(v string) *GetLoggingConfigurationOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *GetLoggingConfigurationOutput) SetName(v string) *GetLoggingConfigurationOutput { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *GetLoggingConfigurationOutput) SetState(v string) *GetLoggingConfigurationOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *GetLoggingConfigurationOutput) SetTags(v map[string]*string) *GetLoggingConfigurationOutput { + s.Tags = v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *GetLoggingConfigurationOutput) SetUpdateTime(v time.Time) *GetLoggingConfigurationOutput { + s.UpdateTime = &v + return s +} + +type GetRoomInput struct { + _ struct{} `type:"structure"` + + // Identifier of the room for which the configuration is to be retrieved. Currently + // this must be an ARN. + // + // Identifier is a required field + Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetRoomInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetRoomInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetRoomInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetRoomInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *GetRoomInput) SetIdentifier(v string) *GetRoomInput { s.Identifier = &v return s } @@ -1921,6 +3010,9 @@ type GetRoomOutput struct { // of the ARN that uniquely identifies the room. Id *string `locationName:"id" min:"12" type:"string"` + // Array of logging configurations attached to the room. + LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"` + // Maximum number of characters in a single message. Messages are expected to // be UTF-8 encoded and this limit applies specifically to rune/code-point count, // not number of bytes. Default: 500. @@ -1981,6 +3073,12 @@ func (s *GetRoomOutput) SetId(v string) *GetRoomOutput { return s } +// SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value. +func (s *GetRoomOutput) SetLoggingConfigurationIdentifiers(v []*string) *GetRoomOutput { + s.LoggingConfigurationIdentifiers = v + return s +} + // SetMaximumMessageLength sets the MaximumMessageLength field's value. func (s *GetRoomOutput) SetMaximumMessageLength(v int64) *GetRoomOutput { s.MaximumMessageLength = &v @@ -2080,9 +3178,110 @@ func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } +type ListLoggingConfigurationsInput struct { + _ struct{} `type:"structure"` + + // Maximum number of logging configurations to return. Default: 50. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // The first logging configurations to retrieve. This is used for pagination; + // see the nextToken response field. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLoggingConfigurationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLoggingConfigurationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListLoggingConfigurationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListLoggingConfigurationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListLoggingConfigurationsInput) SetMaxResults(v int64) *ListLoggingConfigurationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListLoggingConfigurationsInput) SetNextToken(v string) *ListLoggingConfigurationsInput { + s.NextToken = &v + return s +} + +type ListLoggingConfigurationsOutput struct { + _ struct{} `type:"structure"` + + // List of the matching logging configurations (summary information only). There + // is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration. + // + // LoggingConfigurations is a required field + LoggingConfigurations []*LoggingConfigurationSummary `locationName:"loggingConfigurations" type:"list" required:"true"` + + // If there are more logging configurations than maxResults, use nextToken in + // the request to get the next set. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLoggingConfigurationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLoggingConfigurationsOutput) GoString() string { + return s.String() +} + +// SetLoggingConfigurations sets the LoggingConfigurations field's value. +func (s *ListLoggingConfigurationsOutput) SetLoggingConfigurations(v []*LoggingConfigurationSummary) *ListLoggingConfigurationsOutput { + s.LoggingConfigurations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListLoggingConfigurationsOutput) SetNextToken(v string) *ListLoggingConfigurationsOutput { + s.NextToken = &v + return s +} + type ListRoomsInput struct { _ struct{} `type:"structure"` + // Logging-configuration identifier. + LoggingConfigurationIdentifier *string `locationName:"loggingConfigurationIdentifier" min:"1" type:"string"` + // Maximum number of rooms to return. Default: 50. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -2118,6 +3317,9 @@ func (s ListRoomsInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ListRoomsInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListRoomsInput"} + if s.LoggingConfigurationIdentifier != nil && len(*s.LoggingConfigurationIdentifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LoggingConfigurationIdentifier", 1)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -2128,6 +3330,12 @@ func (s *ListRoomsInput) Validate() error { return nil } +// SetLoggingConfigurationIdentifier sets the LoggingConfigurationIdentifier field's value. +func (s *ListRoomsInput) SetLoggingConfigurationIdentifier(v string) *ListRoomsInput { + s.LoggingConfigurationIdentifier = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListRoomsInput) SetMaxResults(v int64) *ListRoomsInput { s.MaxResults = &v @@ -2238,19 +3446,82 @@ func (s *ListTagsForResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { - s.ResourceArn = &v - return s -} +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" type:"map" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// Summary information about a logging configuration. +type LoggingConfigurationSummary struct { + _ struct{} `type:"structure"` + + // Logging-configuration ARN. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // Time when the logging configuration was created. This is an ISO 8601 timestamp; + // note that this is returned as a string. + CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"` + + // A complex type that contains a destination configuration for where chat content + // will be logged. + DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"` + + // Logging-configuration ID, generated by the system. This is a relative identifier, + // the part of the ARN that uniquely identifies the room. + Id *string `locationName:"id" min:"12" type:"string"` + + // Logging-configuration name. The value does not need to be unique. + Name *string `locationName:"name" type:"string"` + + // The state of the logging configuration. When this is ACTIVE, the configuration + // is ready for logging chat content. + State *string `locationName:"state" type:"string" enum:"LoggingConfigurationState"` -type ListTagsForResourceOutput struct { - _ struct{} `type:"structure"` + // Tags to attach to the resource. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints on tags beyond what + // is documented there. + Tags map[string]*string `locationName:"tags" type:"map"` - // Tags attached to the resource, from the request. - // - // Tags is a required field - Tags map[string]*string `locationName:"tags" type:"map" required:"true"` + // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; + // note that this is returned as a string. + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"` } // String returns the string representation. @@ -2258,7 +3529,7 @@ type ListTagsForResourceOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceOutput) String() string { +func (s LoggingConfigurationSummary) String() string { return awsutil.Prettify(s) } @@ -2267,16 +3538,58 @@ func (s ListTagsForResourceOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceOutput) GoString() string { +func (s LoggingConfigurationSummary) GoString() string { return s.String() } +// SetArn sets the Arn field's value. +func (s *LoggingConfigurationSummary) SetArn(v string) *LoggingConfigurationSummary { + s.Arn = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *LoggingConfigurationSummary) SetCreateTime(v time.Time) *LoggingConfigurationSummary { + s.CreateTime = &v + return s +} + +// SetDestinationConfiguration sets the DestinationConfiguration field's value. +func (s *LoggingConfigurationSummary) SetDestinationConfiguration(v *DestinationConfiguration) *LoggingConfigurationSummary { + s.DestinationConfiguration = v + return s +} + +// SetId sets the Id field's value. +func (s *LoggingConfigurationSummary) SetId(v string) *LoggingConfigurationSummary { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *LoggingConfigurationSummary) SetName(v string) *LoggingConfigurationSummary { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *LoggingConfigurationSummary) SetState(v string) *LoggingConfigurationSummary { + s.State = &v + return s +} + // SetTags sets the Tags field's value. -func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { +func (s *LoggingConfigurationSummary) SetTags(v map[string]*string) *LoggingConfigurationSummary { s.Tags = v return s } +// SetUpdateTime sets the UpdateTime field's value. +func (s *LoggingConfigurationSummary) SetUpdateTime(v time.Time) *LoggingConfigurationSummary { + s.UpdateTime = &v + return s +} + // Configuration information for optional message review. type MessageReviewHandler struct { _ struct{} `type:"structure"` @@ -2471,13 +3784,17 @@ type RoomSummary struct { // of the ARN that uniquely identifies the room. Id *string `locationName:"id" min:"12" type:"string"` + // List of logging-configuration identifiers attached to the room. + LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"` + // Configuration information for optional review of messages. MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"` // Room name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` - // Tags attached to the resource. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) // for details, including restrictions that apply to tags and "Tag naming limits // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. @@ -2524,6 +3841,12 @@ func (s *RoomSummary) SetId(v string) *RoomSummary { return s } +// SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value. +func (s *RoomSummary) SetLoggingConfigurationIdentifiers(v []*string) *RoomSummary { + s.LoggingConfigurationIdentifiers = v + return s +} + // SetMessageReviewHandler sets the MessageReviewHandler field's value. func (s *RoomSummary) SetMessageReviewHandler(v *MessageReviewHandler) *RoomSummary { s.MessageReviewHandler = v @@ -2548,6 +3871,56 @@ func (s *RoomSummary) SetUpdateTime(v time.Time) *RoomSummary { return s } +// Specifies an S3 location where chat logs will be stored. +type S3DestinationConfiguration struct { + _ struct{} `type:"structure"` + + // Name of the Amazon S3 bucket where chat activity will be logged. + // + // BucketName is a required field + BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3DestinationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3DestinationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3DestinationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3DestinationConfiguration"} + if s.BucketName == nil { + invalidParams.Add(request.NewErrParamRequired("BucketName")) + } + if s.BucketName != nil && len(*s.BucketName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("BucketName", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucketName sets the BucketName field's value. +func (s *S3DestinationConfiguration) SetBucketName(v string) *S3DestinationConfiguration { + s.BucketName = &v + return s +} + type SendEventInput struct { _ struct{} `type:"structure"` @@ -2737,7 +4110,8 @@ type TagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` - // Array of tags to be added or updated. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // Array of tags to be added or updated. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) // for details, including restrictions that apply to tags and "Tag naming limits // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. @@ -2897,7 +4271,8 @@ type UntagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` - // Array of tags to be removed. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // Array of tags to be removed. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) // for details, including restrictions that apply to tags and "Tag naming limits // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. @@ -2977,6 +4352,181 @@ func (s UntagResourceOutput) GoString() string { return s.String() } +type UpdateLoggingConfigurationInput struct { + _ struct{} `type:"structure"` + + // A complex type that contains a destination configuration for where chat content + // will be logged. There can be only one type of destination (cloudWatchLogs, + // firehose, or s3) in a destinationConfiguration. + DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"` + + // Identifier of the logging configuration to be updated. + // + // Identifier is a required field + Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` + + // Logging-configuration name. The value does not need to be unique. + Name *string `locationName:"name" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateLoggingConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateLoggingConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateLoggingConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateLoggingConfigurationInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + } + if s.DestinationConfiguration != nil { + if err := s.DestinationConfiguration.Validate(); err != nil { + invalidParams.AddNested("DestinationConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestinationConfiguration sets the DestinationConfiguration field's value. +func (s *UpdateLoggingConfigurationInput) SetDestinationConfiguration(v *DestinationConfiguration) *UpdateLoggingConfigurationInput { + s.DestinationConfiguration = v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *UpdateLoggingConfigurationInput) SetIdentifier(v string) *UpdateLoggingConfigurationInput { + s.Identifier = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateLoggingConfigurationInput) SetName(v string) *UpdateLoggingConfigurationInput { + s.Name = &v + return s +} + +type UpdateLoggingConfigurationOutput struct { + _ struct{} `type:"structure"` + + // Logging-configuration ARN, from the request (if identifier was an ARN). + Arn *string `locationName:"arn" min:"1" type:"string"` + + // Time when the logging configuration was created. This is an ISO 8601 timestamp; + // note that this is returned as a string. + CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"` + + // A complex type that contains a destination configuration for where chat content + // will be logged, from the request. There is only one type of destination (cloudWatchLogs, + // firehose, or s3) in a destinationConfiguration. + DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"` + + // Logging-configuration ID, generated by the system. This is a relative identifier, + // the part of the ARN that uniquely identifies the room. + Id *string `locationName:"id" min:"12" type:"string"` + + // Logging-configuration name, from the request (if specified). + Name *string `locationName:"name" type:"string"` + + // The state of the logging configuration. When the state is ACTIVE, the configuration + // is ready to log chat content. + State *string `locationName:"state" type:"string" enum:"UpdateLoggingConfigurationState"` + + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). + Tags map[string]*string `locationName:"tags" type:"map"` + + // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; + // note that this is returned as a string. + UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateLoggingConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateLoggingConfigurationOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *UpdateLoggingConfigurationOutput) SetArn(v string) *UpdateLoggingConfigurationOutput { + s.Arn = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *UpdateLoggingConfigurationOutput) SetCreateTime(v time.Time) *UpdateLoggingConfigurationOutput { + s.CreateTime = &v + return s +} + +// SetDestinationConfiguration sets the DestinationConfiguration field's value. +func (s *UpdateLoggingConfigurationOutput) SetDestinationConfiguration(v *DestinationConfiguration) *UpdateLoggingConfigurationOutput { + s.DestinationConfiguration = v + return s +} + +// SetId sets the Id field's value. +func (s *UpdateLoggingConfigurationOutput) SetId(v string) *UpdateLoggingConfigurationOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateLoggingConfigurationOutput) SetName(v string) *UpdateLoggingConfigurationOutput { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *UpdateLoggingConfigurationOutput) SetState(v string) *UpdateLoggingConfigurationOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *UpdateLoggingConfigurationOutput) SetTags(v map[string]*string) *UpdateLoggingConfigurationOutput { + s.Tags = v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *UpdateLoggingConfigurationOutput) SetUpdateTime(v time.Time) *UpdateLoggingConfigurationOutput { + s.UpdateTime = &v + return s +} + type UpdateRoomInput struct { _ struct{} `type:"structure"` @@ -2985,6 +4535,9 @@ type UpdateRoomInput struct { // Identifier is a required field Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` + // Array of logging-configuration identifiers attached to the room. + LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"` + // The maximum number of characters in a single message. Messages are expected // to be UTF-8 encoded and this limit applies specifically to rune/code-point // count, not number of bytes. Default: 500. @@ -3048,6 +4601,12 @@ func (s *UpdateRoomInput) SetIdentifier(v string) *UpdateRoomInput { return s } +// SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value. +func (s *UpdateRoomInput) SetLoggingConfigurationIdentifiers(v []*string) *UpdateRoomInput { + s.LoggingConfigurationIdentifiers = v + return s +} + // SetMaximumMessageLength sets the MaximumMessageLength field's value. func (s *UpdateRoomInput) SetMaximumMessageLength(v int64) *UpdateRoomInput { s.MaximumMessageLength = &v @@ -3086,20 +4645,25 @@ type UpdateRoomOutput struct { // of the ARN that uniquely identifies the room. Id *string `locationName:"id" min:"12" type:"string"` - // Maximum number of characters in a single message, from the request. + // Array of logging configurations attached to the room, from the request (if + // specified). + LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"` + + // Maximum number of characters in a single message, from the request (if specified). MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"` // Maximum number of messages per second that can be sent to the room (by all - // clients), from the request. + // clients), from the request (if specified). MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"` // Configuration information for optional review of messages. MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"` - // Room name, from the request. + // Room name, from the request (if specified). Name *string `locationName:"name" type:"string"` - // Tags attached to the resource. + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). Tags map[string]*string `locationName:"tags" type:"map"` // Time of the room’s last update. This is an ISO 8601 timestamp; note that @@ -3143,6 +4707,12 @@ func (s *UpdateRoomOutput) SetId(v string) *UpdateRoomOutput { return s } +// SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value. +func (s *UpdateRoomOutput) SetLoggingConfigurationIdentifiers(v []*string) *UpdateRoomOutput { + s.LoggingConfigurationIdentifiers = v + return s +} + // SetMaximumMessageLength sets the MaximumMessageLength field's value. func (s *UpdateRoomOutput) SetMaximumMessageLength(v int64) *UpdateRoomOutput { s.MaximumMessageLength = &v @@ -3312,6 +4882,18 @@ func ChatTokenCapability_Values() []string { } } +const ( + // CreateLoggingConfigurationStateActive is a CreateLoggingConfigurationState enum value + CreateLoggingConfigurationStateActive = "ACTIVE" +) + +// CreateLoggingConfigurationState_Values returns all elements of the CreateLoggingConfigurationState enum +func CreateLoggingConfigurationState_Values() []string { + return []string{ + CreateLoggingConfigurationStateActive, + } +} + const ( // FallbackResultAllow is a FallbackResult enum value FallbackResultAllow = "ALLOW" @@ -3328,6 +4910,42 @@ func FallbackResult_Values() []string { } } +const ( + // LoggingConfigurationStateCreating is a LoggingConfigurationState enum value + LoggingConfigurationStateCreating = "CREATING" + + // LoggingConfigurationStateCreateFailed is a LoggingConfigurationState enum value + LoggingConfigurationStateCreateFailed = "CREATE_FAILED" + + // LoggingConfigurationStateDeleting is a LoggingConfigurationState enum value + LoggingConfigurationStateDeleting = "DELETING" + + // LoggingConfigurationStateDeleteFailed is a LoggingConfigurationState enum value + LoggingConfigurationStateDeleteFailed = "DELETE_FAILED" + + // LoggingConfigurationStateUpdating is a LoggingConfigurationState enum value + LoggingConfigurationStateUpdating = "UPDATING" + + // LoggingConfigurationStateUpdateFailed is a LoggingConfigurationState enum value + LoggingConfigurationStateUpdateFailed = "UPDATE_FAILED" + + // LoggingConfigurationStateActive is a LoggingConfigurationState enum value + LoggingConfigurationStateActive = "ACTIVE" +) + +// LoggingConfigurationState_Values returns all elements of the LoggingConfigurationState enum +func LoggingConfigurationState_Values() []string { + return []string{ + LoggingConfigurationStateCreating, + LoggingConfigurationStateCreateFailed, + LoggingConfigurationStateDeleting, + LoggingConfigurationStateDeleteFailed, + LoggingConfigurationStateUpdating, + LoggingConfigurationStateUpdateFailed, + LoggingConfigurationStateActive, + } +} + const ( // ResourceTypeRoom is a ResourceType enum value ResourceTypeRoom = "ROOM" @@ -3340,6 +4958,18 @@ func ResourceType_Values() []string { } } +const ( + // UpdateLoggingConfigurationStateActive is a UpdateLoggingConfigurationState enum value + UpdateLoggingConfigurationStateActive = "ACTIVE" +) + +// UpdateLoggingConfigurationState_Values returns all elements of the UpdateLoggingConfigurationState enum +func UpdateLoggingConfigurationState_Values() []string { + return []string{ + UpdateLoggingConfigurationStateActive, + } +} + const ( // ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION" diff --git a/service/ivschat/doc.go b/service/ivschat/doc.go index 364c57ec7c5..5b7356acb41 100644 --- a/service/ivschat/doc.go +++ b/service/ivschat/doc.go @@ -25,7 +25,11 @@ // // # Resources // -// The following resource is part of Amazon IVS Chat: +// The following resources are part of Amazon IVS Chat: +// +// - LoggingConfiguration — A configuration that allows customers to store +// and record sent messages in a chat room. See the Logging Configuration +// endpoints for more information. // // - Room — The central Amazon IVS Chat resource through which clients // connect to and exchange chat messages. See the Room endpoints for more @@ -114,10 +118,11 @@ // // Chat Token Endpoint // -// - CreateChatToken — Creates an encrypted token that is used to establish -// an individual WebSocket connection to a room. The token is valid for one -// minute, and a connection (session) established with the token is valid -// for the specified duration. +// - CreateChatToken — Creates an encrypted token that is used by a chat +// participant to establish an individual WebSocket chat connection to a +// room. When the token is used to connect to chat, the connection is valid +// for the session duration specified in the request. The token becomes invalid +// at the token-expiration timestamp included in the response. // // Room Endpoints // @@ -133,6 +138,20 @@ // // - UpdateRoom — Updates a room’s configuration. // +// Logging Configuration Endpoints +// +// - CreateLoggingConfiguration — Creates a logging configuration that +// allows clients to store and record sent messages. +// +// - DeleteLoggingConfiguration — Deletes the specified logging configuration. +// +// - GetLoggingConfiguration — Gets the specified logging configuration. +// +// - ListLoggingConfigurations — Gets summary information about all your +// logging configurations in the AWS region where the API request is processed. +// +// - UpdateLoggingConfiguration — Updates a specified logging configuration. +// // Tags Endpoints // // - ListTagsForResource — Gets information about AWS tags for the specified diff --git a/service/ivschat/ivschatiface/interface.go b/service/ivschat/ivschatiface/interface.go index e22564337ad..428f36b41da 100644 --- a/service/ivschat/ivschatiface/interface.go +++ b/service/ivschat/ivschatiface/interface.go @@ -64,10 +64,18 @@ type IvschatAPI interface { CreateChatTokenWithContext(aws.Context, *ivschat.CreateChatTokenInput, ...request.Option) (*ivschat.CreateChatTokenOutput, error) CreateChatTokenRequest(*ivschat.CreateChatTokenInput) (*request.Request, *ivschat.CreateChatTokenOutput) + CreateLoggingConfiguration(*ivschat.CreateLoggingConfigurationInput) (*ivschat.CreateLoggingConfigurationOutput, error) + CreateLoggingConfigurationWithContext(aws.Context, *ivschat.CreateLoggingConfigurationInput, ...request.Option) (*ivschat.CreateLoggingConfigurationOutput, error) + CreateLoggingConfigurationRequest(*ivschat.CreateLoggingConfigurationInput) (*request.Request, *ivschat.CreateLoggingConfigurationOutput) + CreateRoom(*ivschat.CreateRoomInput) (*ivschat.CreateRoomOutput, error) CreateRoomWithContext(aws.Context, *ivschat.CreateRoomInput, ...request.Option) (*ivschat.CreateRoomOutput, error) CreateRoomRequest(*ivschat.CreateRoomInput) (*request.Request, *ivschat.CreateRoomOutput) + DeleteLoggingConfiguration(*ivschat.DeleteLoggingConfigurationInput) (*ivschat.DeleteLoggingConfigurationOutput, error) + DeleteLoggingConfigurationWithContext(aws.Context, *ivschat.DeleteLoggingConfigurationInput, ...request.Option) (*ivschat.DeleteLoggingConfigurationOutput, error) + DeleteLoggingConfigurationRequest(*ivschat.DeleteLoggingConfigurationInput) (*request.Request, *ivschat.DeleteLoggingConfigurationOutput) + DeleteMessage(*ivschat.DeleteMessageInput) (*ivschat.DeleteMessageOutput, error) DeleteMessageWithContext(aws.Context, *ivschat.DeleteMessageInput, ...request.Option) (*ivschat.DeleteMessageOutput, error) DeleteMessageRequest(*ivschat.DeleteMessageInput) (*request.Request, *ivschat.DeleteMessageOutput) @@ -80,10 +88,21 @@ type IvschatAPI interface { DisconnectUserWithContext(aws.Context, *ivschat.DisconnectUserInput, ...request.Option) (*ivschat.DisconnectUserOutput, error) DisconnectUserRequest(*ivschat.DisconnectUserInput) (*request.Request, *ivschat.DisconnectUserOutput) + GetLoggingConfiguration(*ivschat.GetLoggingConfigurationInput) (*ivschat.GetLoggingConfigurationOutput, error) + GetLoggingConfigurationWithContext(aws.Context, *ivschat.GetLoggingConfigurationInput, ...request.Option) (*ivschat.GetLoggingConfigurationOutput, error) + GetLoggingConfigurationRequest(*ivschat.GetLoggingConfigurationInput) (*request.Request, *ivschat.GetLoggingConfigurationOutput) + GetRoom(*ivschat.GetRoomInput) (*ivschat.GetRoomOutput, error) GetRoomWithContext(aws.Context, *ivschat.GetRoomInput, ...request.Option) (*ivschat.GetRoomOutput, error) GetRoomRequest(*ivschat.GetRoomInput) (*request.Request, *ivschat.GetRoomOutput) + ListLoggingConfigurations(*ivschat.ListLoggingConfigurationsInput) (*ivschat.ListLoggingConfigurationsOutput, error) + ListLoggingConfigurationsWithContext(aws.Context, *ivschat.ListLoggingConfigurationsInput, ...request.Option) (*ivschat.ListLoggingConfigurationsOutput, error) + ListLoggingConfigurationsRequest(*ivschat.ListLoggingConfigurationsInput) (*request.Request, *ivschat.ListLoggingConfigurationsOutput) + + ListLoggingConfigurationsPages(*ivschat.ListLoggingConfigurationsInput, func(*ivschat.ListLoggingConfigurationsOutput, bool) bool) error + ListLoggingConfigurationsPagesWithContext(aws.Context, *ivschat.ListLoggingConfigurationsInput, func(*ivschat.ListLoggingConfigurationsOutput, bool) bool, ...request.Option) error + ListRooms(*ivschat.ListRoomsInput) (*ivschat.ListRoomsOutput, error) ListRoomsWithContext(aws.Context, *ivschat.ListRoomsInput, ...request.Option) (*ivschat.ListRoomsOutput, error) ListRoomsRequest(*ivschat.ListRoomsInput) (*request.Request, *ivschat.ListRoomsOutput) @@ -107,6 +126,10 @@ type IvschatAPI interface { UntagResourceWithContext(aws.Context, *ivschat.UntagResourceInput, ...request.Option) (*ivschat.UntagResourceOutput, error) UntagResourceRequest(*ivschat.UntagResourceInput) (*request.Request, *ivschat.UntagResourceOutput) + UpdateLoggingConfiguration(*ivschat.UpdateLoggingConfigurationInput) (*ivschat.UpdateLoggingConfigurationOutput, error) + UpdateLoggingConfigurationWithContext(aws.Context, *ivschat.UpdateLoggingConfigurationInput, ...request.Option) (*ivschat.UpdateLoggingConfigurationOutput, error) + UpdateLoggingConfigurationRequest(*ivschat.UpdateLoggingConfigurationInput) (*request.Request, *ivschat.UpdateLoggingConfigurationOutput) + UpdateRoom(*ivschat.UpdateRoomInput) (*ivschat.UpdateRoomOutput, error) UpdateRoomWithContext(aws.Context, *ivschat.UpdateRoomInput, ...request.Option) (*ivschat.UpdateRoomOutput, error) UpdateRoomRequest(*ivschat.UpdateRoomInput) (*request.Request, *ivschat.UpdateRoomOutput) diff --git a/service/lambda/api.go b/service/lambda/api.go index 1f9855218e4..59458f703ae 100644 --- a/service/lambda/api.go +++ b/service/lambda/api.go @@ -377,7 +377,7 @@ func (c *Lambda) CreateCodeSigningConfigRequest(input *CreateCodeSigningConfigIn // CreateCodeSigningConfig API operation for AWS Lambda. // -// Creates a code signing configuration. A code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-trustedcode.html) +// Creates a code signing configuration. A code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) // defines a list of allowed signing profiles and defines the code-signing validation // policy (action to be taken if deployment validation checks fail). // @@ -7504,7 +7504,7 @@ type AmazonManagedKafkaEventSourceConfig struct { // The identifier for the Kafka consumer group to join. The consumer group ID // must be unique among all your Kafka event sources. After creating a Kafka // event source mapping with the consumer group ID specified, you cannot update - // this value. For more information, see services-msk-consumer-group-id. + // this value. For more information, see Customizable consumer group ID (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). ConsumerGroupId *string `min:"1" type:"string"` } @@ -8258,13 +8258,21 @@ type CreateEventSourceMappingInput struct { // the event source mapping. FunctionResponseTypes []*string `type:"list" enum:"FunctionResponseType"` - // (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, - // that Lambda spends gathering records before invoking the function. + // The maximum amount of time, in seconds, that Lambda spends gathering records + // before invoking the function. You can configure MaximumBatchingWindowInSeconds + // to any value from 0 seconds to 300 seconds in increments of seconds. // - // Default: 0 + // For streams and Amazon SQS event sources, the default batching window is + // 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event + // sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you + // cannot revert back to the 500 ms default batching window after you have changed + // it. To restore the default batching window, you must create a new event source + // mapping. // - // Related setting: When you set BatchSize to a value greater than 10, you must - // set MaximumBatchingWindowInSeconds to at least 1. + // Related setting: For streams and Amazon SQS event sources, when you set BatchSize + // to a value greater than 10, you must set MaximumBatchingWindowInSeconds to + // at least 1. MaximumBatchingWindowInSeconds *int64 `type:"integer"` // (Streams only) Discard records older than the specified age. The default @@ -10562,7 +10570,7 @@ type EnvironmentResponse struct { // Error messages for environment variables that couldn't be applied. Error *EnvironmentError `type:"structure"` - // Environment variable key-value pairs. + // Environment variable key-value pairs. Omitted from CloudTrail logs. // // Variables is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by EnvironmentResponse's @@ -10702,13 +10710,21 @@ type EventSourceMappingConfiguration struct { // The result of the last Lambda invocation of your function. LastProcessingResult *string `type:"string"` - // (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, - // that Lambda spends gathering records before invoking the function. + // The maximum amount of time, in seconds, that Lambda spends gathering records + // before invoking the function. You can configure MaximumBatchingWindowInSeconds + // to any value from 0 seconds to 300 seconds in increments of seconds. // - // Default: 0 + // For streams and Amazon SQS event sources, the default batching window is + // 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event + // sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you + // cannot revert back to the 500 ms default batching window after you have changed + // it. To restore the default batching window, you must create a new event source + // mapping. // - // Related setting: When you set BatchSize to a value greater than 10, you must - // set MaximumBatchingWindowInSeconds to at least 1. + // Related setting: For streams and Amazon SQS event sources, when you set BatchSize + // to a value greater than 10, you must set MaximumBatchingWindowInSeconds to + // at least 1. MaximumBatchingWindowInSeconds *int64 `type:"integer"` // (Streams only) Discard records older than the specified age. The default @@ -11242,6 +11258,7 @@ type FunctionConfiguration struct { Description *string `type:"string"` // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). + // Omitted from CloudTrail logs. Environment *EnvironmentResponse `type:"structure"` // The size of the function’s /tmp directory in MB. The default value is 512, @@ -13332,7 +13349,9 @@ func (s *GetProvisionedConcurrencyConfigInput) SetQualifier(v string) *GetProvis type GetProvisionedConcurrencyConfigOutput struct { _ struct{} `type:"structure"` - // The amount of provisioned concurrency allocated. + // The amount of provisioned concurrency allocated. When a weighted alias is + // used during linear and canary deployments, this value fluctuates depending + // on the amount of concurrency that is provisioned for the function versions. AllocatedProvisionedConcurrentExecutions *int64 `type:"integer"` // The amount of provisioned concurrency available. @@ -16559,7 +16578,9 @@ func (s *PreconditionFailedException) RequestID() string { type ProvisionedConcurrencyConfigListItem struct { _ struct{} `type:"structure"` - // The amount of provisioned concurrency allocated. + // The amount of provisioned concurrency allocated. When a weighted alias is + // used during linear and canary deployments, this value fluctuates depending + // on the amount of concurrency that is provisioned for the function versions. AllocatedProvisionedConcurrentExecutions *int64 `type:"integer"` // The amount of provisioned concurrency available. @@ -17540,7 +17561,9 @@ func (s *PutProvisionedConcurrencyConfigInput) SetQualifier(v string) *PutProvis type PutProvisionedConcurrencyConfigOutput struct { _ struct{} `type:"structure"` - // The amount of provisioned concurrency allocated. + // The amount of provisioned concurrency allocated. When a weighted alias is + // used during linear and canary deployments, this value fluctuates depending + // on the amount of concurrency that is provisioned for the function versions. AllocatedProvisionedConcurrentExecutions *int64 `type:"integer"` // The amount of provisioned concurrency available. @@ -18242,7 +18265,7 @@ type SelfManagedKafkaEventSourceConfig struct { // The identifier for the Kafka consumer group to join. The consumer group ID // must be unique among all your Kafka event sources. After creating a Kafka // event source mapping with the consumer group ID specified, you cannot update - // this value. For more information, see services-msk-consumer-group-id. + // this value. For more information, see Customizable consumer group ID (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). ConsumerGroupId *string `min:"1" type:"string"` } @@ -18364,19 +18387,22 @@ type SourceAccessConfiguration struct { // your secret key used for SASL/PLAIN authentication of your Apache Kafka // brokers. // - // * VPC_SUBNET - The subnets associated with your VPC. Lambda connects to - // these subnets to fetch data from your self-managed Apache Kafka cluster. + // * VPC_SUBNET - (Self-managed Apache Kafka) The subnets associated with + // your VPC. Lambda connects to these subnets to fetch data from your self-managed + // Apache Kafka cluster. // - // * VPC_SECURITY_GROUP - The VPC security group used to manage access to - // your self-managed Apache Kafka brokers. + // * VPC_SECURITY_GROUP - (Self-managed Apache Kafka) The VPC security group + // used to manage access to your self-managed Apache Kafka brokers. // - // * SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used - // for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers. + // * SASL_SCRAM_256_AUTH - (Self-managed Apache Kafka) The Secrets Manager + // ARN of your secret key used for SASL SCRAM-256 authentication of your + // self-managed Apache Kafka brokers. // - // * SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used - // for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers. + // * SASL_SCRAM_512_AUTH - (Amazon MSK, Self-managed Apache Kafka) The Secrets + // Manager ARN of your secret key used for SASL SCRAM-512 authentication + // of your self-managed Apache Kafka brokers. // - // * VIRTUAL_HOST - (Amazon MQ) The name of the virtual host in your RabbitMQ + // * VIRTUAL_HOST - (RabbitMQ) The name of the virtual host in your RabbitMQ // broker. Lambda uses this RabbitMQ host as the event source. This property // cannot be specified in an UpdateEventSourceMapping API call. // @@ -19172,13 +19198,21 @@ type UpdateEventSourceMappingInput struct { // the event source mapping. FunctionResponseTypes []*string `type:"list" enum:"FunctionResponseType"` - // (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, - // that Lambda spends gathering records before invoking the function. + // The maximum amount of time, in seconds, that Lambda spends gathering records + // before invoking the function. You can configure MaximumBatchingWindowInSeconds + // to any value from 0 seconds to 300 seconds in increments of seconds. // - // Default: 0 + // For streams and Amazon SQS event sources, the default batching window is + // 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event + // sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you + // cannot revert back to the 500 ms default batching window after you have changed + // it. To restore the default batching window, you must create a new event source + // mapping. // - // Related setting: When you set BatchSize to a value greater than 10, you must - // set MaximumBatchingWindowInSeconds to at least 1. + // Related setting: For streams and Amazon SQS event sources, when you set BatchSize + // to a value greater than 10, you must set MaximumBatchingWindowInSeconds to + // at least 1. MaximumBatchingWindowInSeconds *int64 `type:"integer"` // (Streams only) Discard records older than the specified age. The default @@ -20562,6 +20596,9 @@ const ( // RuntimeProvidedAl2 is a Runtime enum value RuntimeProvidedAl2 = "provided.al2" + + // RuntimeNodejs18X is a Runtime enum value + RuntimeNodejs18X = "nodejs18.x" ) // Runtime_Values returns all elements of the Runtime enum @@ -20594,6 +20631,7 @@ func Runtime_Values() []string { RuntimeRuby27, RuntimeProvided, RuntimeProvidedAl2, + RuntimeNodejs18X, } } diff --git a/service/personalize/api.go b/service/personalize/api.go index eb3c35609f5..e0e454bd8e9 100644 --- a/service/personalize/api.go +++ b/service/personalize/api.go @@ -1057,6 +1057,100 @@ func (c *Personalize) CreateFilterWithContext(ctx aws.Context, input *CreateFilt return out, req.Send() } +const opCreateMetricAttribution = "CreateMetricAttribution" + +// CreateMetricAttributionRequest generates a "aws/request.Request" representing the +// client's request for the CreateMetricAttribution operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateMetricAttribution for more information on using the CreateMetricAttribution +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateMetricAttributionRequest method. +// req, resp := client.CreateMetricAttributionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateMetricAttribution +func (c *Personalize) CreateMetricAttributionRequest(input *CreateMetricAttributionInput) (req *request.Request, output *CreateMetricAttributionOutput) { + op := &request.Operation{ + Name: opCreateMetricAttribution, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateMetricAttributionInput{} + } + + output = &CreateMetricAttributionOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateMetricAttribution API operation for Amazon Personalize. +// +// Creates a metric attribution. A metric attribution creates reports on the +// data that you import into Amazon Personalize. Depending on how you imported +// the data, you can view reports in Amazon CloudWatch or Amazon S3. For more +// information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation CreateMetricAttribution for usage and error information. +// +// Returned Error Types: +// +// - InvalidInputException +// Provide a valid value for the field or parameter. +// +// - ResourceNotFoundException +// Could not find the specified resource. +// +// - ResourceAlreadyExistsException +// The specified resource already exists. +// +// - ResourceInUseException +// The specified resource is in use. +// +// - LimitExceededException +// The limit on the number of requests per second has been exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateMetricAttribution +func (c *Personalize) CreateMetricAttribution(input *CreateMetricAttributionInput) (*CreateMetricAttributionOutput, error) { + req, out := c.CreateMetricAttributionRequest(input) + return out, req.Send() +} + +// CreateMetricAttributionWithContext is the same as CreateMetricAttribution with the addition of +// the ability to pass a context and additional request options. +// +// See CreateMetricAttribution for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) CreateMetricAttributionWithContext(ctx aws.Context, input *CreateMetricAttributionInput, opts ...request.Option) (*CreateMetricAttributionOutput, error) { + req, out := c.CreateMetricAttributionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateRecommender = "CreateRecommender" // CreateRecommenderRequest generates a "aws/request.Request" representing the @@ -1554,6 +1648,9 @@ func (c *Personalize) CreateSolutionVersionRequest(input *CreateSolutionVersionI // - TooManyTagsException // You have exceeded the maximum number of tags you can apply to this resource. // +// - ResourceAlreadyExistsException +// The specified resource already exists. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersion func (c *Personalize) CreateSolutionVersion(input *CreateSolutionVersionInput) (*CreateSolutionVersionOutput, error) { req, out := c.CreateSolutionVersionRequest(input) @@ -2020,6 +2117,92 @@ func (c *Personalize) DeleteFilterWithContext(ctx aws.Context, input *DeleteFilt return out, req.Send() } +const opDeleteMetricAttribution = "DeleteMetricAttribution" + +// DeleteMetricAttributionRequest generates a "aws/request.Request" representing the +// client's request for the DeleteMetricAttribution operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteMetricAttribution for more information on using the DeleteMetricAttribution +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteMetricAttributionRequest method. +// req, resp := client.DeleteMetricAttributionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteMetricAttribution +func (c *Personalize) DeleteMetricAttributionRequest(input *DeleteMetricAttributionInput) (req *request.Request, output *DeleteMetricAttributionOutput) { + op := &request.Operation{ + Name: opDeleteMetricAttribution, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteMetricAttributionInput{} + } + + output = &DeleteMetricAttributionOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteMetricAttribution API operation for Amazon Personalize. +// +// Deletes a metric attribution. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation DeleteMetricAttribution for usage and error information. +// +// Returned Error Types: +// +// - InvalidInputException +// Provide a valid value for the field or parameter. +// +// - ResourceNotFoundException +// Could not find the specified resource. +// +// - ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteMetricAttribution +func (c *Personalize) DeleteMetricAttribution(input *DeleteMetricAttributionInput) (*DeleteMetricAttributionOutput, error) { + req, out := c.DeleteMetricAttributionRequest(input) + return out, req.Send() +} + +// DeleteMetricAttributionWithContext is the same as DeleteMetricAttribution with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteMetricAttribution for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) DeleteMetricAttributionWithContext(ctx aws.Context, input *DeleteMetricAttributionInput, opts ...request.Option) (*DeleteMetricAttributionOutput, error) { + req, out := c.DeleteMetricAttributionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteRecommender = "DeleteRecommender" // DeleteRecommenderRequest generates a "aws/request.Request" representing the @@ -3210,6 +3393,88 @@ func (c *Personalize) DescribeFilterWithContext(ctx aws.Context, input *Describe return out, req.Send() } +const opDescribeMetricAttribution = "DescribeMetricAttribution" + +// DescribeMetricAttributionRequest generates a "aws/request.Request" representing the +// client's request for the DescribeMetricAttribution operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeMetricAttribution for more information on using the DescribeMetricAttribution +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeMetricAttributionRequest method. +// req, resp := client.DescribeMetricAttributionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeMetricAttribution +func (c *Personalize) DescribeMetricAttributionRequest(input *DescribeMetricAttributionInput) (req *request.Request, output *DescribeMetricAttributionOutput) { + op := &request.Operation{ + Name: opDescribeMetricAttribution, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeMetricAttributionInput{} + } + + output = &DescribeMetricAttributionOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeMetricAttribution API operation for Amazon Personalize. +// +// Describes a metric attribution. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation DescribeMetricAttribution for usage and error information. +// +// Returned Error Types: +// +// - InvalidInputException +// Provide a valid value for the field or parameter. +// +// - ResourceNotFoundException +// Could not find the specified resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeMetricAttribution +func (c *Personalize) DescribeMetricAttribution(input *DescribeMetricAttributionInput) (*DescribeMetricAttributionOutput, error) { + req, out := c.DescribeMetricAttributionRequest(input) + return out, req.Send() +} + +// DescribeMetricAttributionWithContext is the same as DescribeMetricAttribution with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeMetricAttribution for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) DescribeMetricAttributionWithContext(ctx aws.Context, input *DescribeMetricAttributionInput, opts ...request.Option) (*DescribeMetricAttributionOutput, error) { + req, out := c.DescribeMetricAttributionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeRecipe = "DescribeRecipe" // DescribeRecipeRequest generates a "aws/request.Request" representing the @@ -5009,34 +5274,34 @@ func (c *Personalize) ListFiltersPagesWithContext(ctx aws.Context, input *ListFi return p.Err() } -const opListRecipes = "ListRecipes" +const opListMetricAttributionMetrics = "ListMetricAttributionMetrics" -// ListRecipesRequest generates a "aws/request.Request" representing the -// client's request for the ListRecipes operation. The "output" return +// ListMetricAttributionMetricsRequest generates a "aws/request.Request" representing the +// client's request for the ListMetricAttributionMetrics operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListRecipes for more information on using the ListRecipes +// See ListMetricAttributionMetrics for more information on using the ListMetricAttributionMetrics // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListRecipesRequest method. -// req, resp := client.ListRecipesRequest(params) +// // Example sending a request using the ListMetricAttributionMetricsRequest method. +// req, resp := client.ListMetricAttributionMetricsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes -func (c *Personalize) ListRecipesRequest(input *ListRecipesInput) (req *request.Request, output *ListRecipesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionMetrics +func (c *Personalize) ListMetricAttributionMetricsRequest(input *ListMetricAttributionMetricsInput) (req *request.Request, output *ListMetricAttributionMetricsOutput) { op := &request.Operation{ - Name: opListRecipes, + Name: opListMetricAttributionMetrics, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -5048,92 +5313,91 @@ func (c *Personalize) ListRecipesRequest(input *ListRecipesInput) (req *request. } if input == nil { - input = &ListRecipesInput{} + input = &ListMetricAttributionMetricsInput{} } - output = &ListRecipesOutput{} + output = &ListMetricAttributionMetricsOutput{} req = c.newRequest(op, input, output) return } -// ListRecipes API operation for Amazon Personalize. +// ListMetricAttributionMetrics API operation for Amazon Personalize. // -// Returns a list of available recipes. The response provides the properties -// for each recipe, including the recipe's Amazon Resource Name (ARN). +// Lists the metrics for the metric attribution. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Personalize's -// API operation ListRecipes for usage and error information. +// API operation ListMetricAttributionMetrics for usage and error information. // // Returned Error Types: // -// - InvalidNextTokenException -// The token is not valid. -// // - InvalidInputException // Provide a valid value for the field or parameter. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes -func (c *Personalize) ListRecipes(input *ListRecipesInput) (*ListRecipesOutput, error) { - req, out := c.ListRecipesRequest(input) +// - InvalidNextTokenException +// The token is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionMetrics +func (c *Personalize) ListMetricAttributionMetrics(input *ListMetricAttributionMetricsInput) (*ListMetricAttributionMetricsOutput, error) { + req, out := c.ListMetricAttributionMetricsRequest(input) return out, req.Send() } -// ListRecipesWithContext is the same as ListRecipes with the addition of +// ListMetricAttributionMetricsWithContext is the same as ListMetricAttributionMetrics with the addition of // the ability to pass a context and additional request options. // -// See ListRecipes for details on how to use this API operation. +// See ListMetricAttributionMetrics for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) ListRecipesWithContext(ctx aws.Context, input *ListRecipesInput, opts ...request.Option) (*ListRecipesOutput, error) { - req, out := c.ListRecipesRequest(input) +func (c *Personalize) ListMetricAttributionMetricsWithContext(ctx aws.Context, input *ListMetricAttributionMetricsInput, opts ...request.Option) (*ListMetricAttributionMetricsOutput, error) { + req, out := c.ListMetricAttributionMetricsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListRecipesPages iterates over the pages of a ListRecipes operation, +// ListMetricAttributionMetricsPages iterates over the pages of a ListMetricAttributionMetrics operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListRecipes method for more information on how to use this operation. +// See ListMetricAttributionMetrics method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListRecipes operation. +// // Example iterating over at most 3 pages of a ListMetricAttributionMetrics operation. // pageNum := 0 -// err := client.ListRecipesPages(params, -// func(page *personalize.ListRecipesOutput, lastPage bool) bool { +// err := client.ListMetricAttributionMetricsPages(params, +// func(page *personalize.ListMetricAttributionMetricsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Personalize) ListRecipesPages(input *ListRecipesInput, fn func(*ListRecipesOutput, bool) bool) error { - return c.ListRecipesPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Personalize) ListMetricAttributionMetricsPages(input *ListMetricAttributionMetricsInput, fn func(*ListMetricAttributionMetricsOutput, bool) bool) error { + return c.ListMetricAttributionMetricsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListRecipesPagesWithContext same as ListRecipesPages except +// ListMetricAttributionMetricsPagesWithContext same as ListMetricAttributionMetricsPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) ListRecipesPagesWithContext(ctx aws.Context, input *ListRecipesInput, fn func(*ListRecipesOutput, bool) bool, opts ...request.Option) error { +func (c *Personalize) ListMetricAttributionMetricsPagesWithContext(ctx aws.Context, input *ListMetricAttributionMetricsInput, fn func(*ListMetricAttributionMetricsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListRecipesInput + var inCpy *ListMetricAttributionMetricsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListRecipesRequest(inCpy) + req, _ := c.ListMetricAttributionMetricsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -5141,7 +5405,7 @@ func (c *Personalize) ListRecipesPagesWithContext(ctx aws.Context, input *ListRe } for p.Next() { - if !fn(p.Page().(*ListRecipesOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListMetricAttributionMetricsOutput), !p.HasNextPage()) { break } } @@ -5149,34 +5413,34 @@ func (c *Personalize) ListRecipesPagesWithContext(ctx aws.Context, input *ListRe return p.Err() } -const opListRecommenders = "ListRecommenders" +const opListMetricAttributions = "ListMetricAttributions" -// ListRecommendersRequest generates a "aws/request.Request" representing the -// client's request for the ListRecommenders operation. The "output" return +// ListMetricAttributionsRequest generates a "aws/request.Request" representing the +// client's request for the ListMetricAttributions operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListRecommenders for more information on using the ListRecommenders +// See ListMetricAttributions for more information on using the ListMetricAttributions // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListRecommendersRequest method. -// req, resp := client.ListRecommendersRequest(params) +// // Example sending a request using the ListMetricAttributionsRequest method. +// req, resp := client.ListMetricAttributionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders -func (c *Personalize) ListRecommendersRequest(input *ListRecommendersInput) (req *request.Request, output *ListRecommendersOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributions +func (c *Personalize) ListMetricAttributionsRequest(input *ListMetricAttributionsInput) (req *request.Request, output *ListMetricAttributionsOutput) { op := &request.Operation{ - Name: opListRecommenders, + Name: opListMetricAttributions, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -5188,21 +5452,300 @@ func (c *Personalize) ListRecommendersRequest(input *ListRecommendersInput) (req } if input == nil { - input = &ListRecommendersInput{} + input = &ListMetricAttributionsInput{} } - output = &ListRecommendersOutput{} + output = &ListMetricAttributionsOutput{} req = c.newRequest(op, input, output) return } -// ListRecommenders API operation for Amazon Personalize. +// ListMetricAttributions API operation for Amazon Personalize. // -// Returns a list of recommenders in a given Domain dataset group. When a Domain -// dataset group is not specified, all the recommenders associated with the -// account are listed. The response provides the properties for each recommender, -// including the Amazon Resource Name (ARN). For more information on recommenders, -// see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html). +// Lists metric attributions. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation ListMetricAttributions for usage and error information. +// +// Returned Error Types: +// +// - InvalidInputException +// Provide a valid value for the field or parameter. +// +// - InvalidNextTokenException +// The token is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributions +func (c *Personalize) ListMetricAttributions(input *ListMetricAttributionsInput) (*ListMetricAttributionsOutput, error) { + req, out := c.ListMetricAttributionsRequest(input) + return out, req.Send() +} + +// ListMetricAttributionsWithContext is the same as ListMetricAttributions with the addition of +// the ability to pass a context and additional request options. +// +// See ListMetricAttributions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListMetricAttributionsWithContext(ctx aws.Context, input *ListMetricAttributionsInput, opts ...request.Option) (*ListMetricAttributionsOutput, error) { + req, out := c.ListMetricAttributionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListMetricAttributionsPages iterates over the pages of a ListMetricAttributions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListMetricAttributions method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListMetricAttributions operation. +// pageNum := 0 +// err := client.ListMetricAttributionsPages(params, +// func(page *personalize.ListMetricAttributionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Personalize) ListMetricAttributionsPages(input *ListMetricAttributionsInput, fn func(*ListMetricAttributionsOutput, bool) bool) error { + return c.ListMetricAttributionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListMetricAttributionsPagesWithContext same as ListMetricAttributionsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListMetricAttributionsPagesWithContext(ctx aws.Context, input *ListMetricAttributionsInput, fn func(*ListMetricAttributionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListMetricAttributionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListMetricAttributionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListMetricAttributionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListRecipes = "ListRecipes" + +// ListRecipesRequest generates a "aws/request.Request" representing the +// client's request for the ListRecipes operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListRecipes for more information on using the ListRecipes +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListRecipesRequest method. +// req, resp := client.ListRecipesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes +func (c *Personalize) ListRecipesRequest(input *ListRecipesInput) (req *request.Request, output *ListRecipesOutput) { + op := &request.Operation{ + Name: opListRecipes, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListRecipesInput{} + } + + output = &ListRecipesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListRecipes API operation for Amazon Personalize. +// +// Returns a list of available recipes. The response provides the properties +// for each recipe, including the recipe's Amazon Resource Name (ARN). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation ListRecipes for usage and error information. +// +// Returned Error Types: +// +// - InvalidNextTokenException +// The token is not valid. +// +// - InvalidInputException +// Provide a valid value for the field or parameter. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes +func (c *Personalize) ListRecipes(input *ListRecipesInput) (*ListRecipesOutput, error) { + req, out := c.ListRecipesRequest(input) + return out, req.Send() +} + +// ListRecipesWithContext is the same as ListRecipes with the addition of +// the ability to pass a context and additional request options. +// +// See ListRecipes for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListRecipesWithContext(ctx aws.Context, input *ListRecipesInput, opts ...request.Option) (*ListRecipesOutput, error) { + req, out := c.ListRecipesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListRecipesPages iterates over the pages of a ListRecipes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRecipes method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListRecipes operation. +// pageNum := 0 +// err := client.ListRecipesPages(params, +// func(page *personalize.ListRecipesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Personalize) ListRecipesPages(input *ListRecipesInput, fn func(*ListRecipesOutput, bool) bool) error { + return c.ListRecipesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRecipesPagesWithContext same as ListRecipesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListRecipesPagesWithContext(ctx aws.Context, input *ListRecipesInput, fn func(*ListRecipesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRecipesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRecipesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRecipesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListRecommenders = "ListRecommenders" + +// ListRecommendersRequest generates a "aws/request.Request" representing the +// client's request for the ListRecommenders operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListRecommenders for more information on using the ListRecommenders +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListRecommendersRequest method. +// req, resp := client.ListRecommendersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders +func (c *Personalize) ListRecommendersRequest(input *ListRecommendersInput) (req *request.Request, output *ListRecommendersOutput) { + op := &request.Operation{ + Name: opListRecommenders, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListRecommendersInput{} + } + + output = &ListRecommendersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListRecommenders API operation for Amazon Personalize. +// +// Returns a list of recommenders in a given Domain dataset group. When a Domain +// dataset group is not specified, all the recommenders associated with the +// account are listed. The response provides the properties for each recommender, +// including the Amazon Resource Name (ARN). For more information on recommenders, +// see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6310,14 +6853,99 @@ func (c *Personalize) UpdateCampaignRequest(input *UpdateCampaignInput) (req *re // The campaign will use the previous solution version and campaign configuration // to generate recommendations until the latest campaign update status is Active. // -// For more information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// For more information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation UpdateCampaign for usage and error information. +// +// Returned Error Types: +// +// - InvalidInputException +// Provide a valid value for the field or parameter. +// +// - ResourceNotFoundException +// Could not find the specified resource. +// +// - ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaign +func (c *Personalize) UpdateCampaign(input *UpdateCampaignInput) (*UpdateCampaignOutput, error) { + req, out := c.UpdateCampaignRequest(input) + return out, req.Send() +} + +// UpdateCampaignWithContext is the same as UpdateCampaign with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateCampaign for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) UpdateCampaignWithContext(ctx aws.Context, input *UpdateCampaignInput, opts ...request.Option) (*UpdateCampaignOutput, error) { + req, out := c.UpdateCampaignRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateMetricAttribution = "UpdateMetricAttribution" + +// UpdateMetricAttributionRequest generates a "aws/request.Request" representing the +// client's request for the UpdateMetricAttribution operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateMetricAttribution for more information on using the UpdateMetricAttribution +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateMetricAttributionRequest method. +// req, resp := client.UpdateMetricAttributionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateMetricAttribution +func (c *Personalize) UpdateMetricAttributionRequest(input *UpdateMetricAttributionInput) (req *request.Request, output *UpdateMetricAttributionOutput) { + op := &request.Operation{ + Name: opUpdateMetricAttribution, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateMetricAttributionInput{} + } + + output = &UpdateMetricAttributionOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateMetricAttribution API operation for Amazon Personalize. +// +// Updates a metric attribution. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Personalize's -// API operation UpdateCampaign for usage and error information. +// API operation UpdateMetricAttribution for usage and error information. // // Returned Error Types: // @@ -6330,23 +6958,26 @@ func (c *Personalize) UpdateCampaignRequest(input *UpdateCampaignInput) (req *re // - ResourceInUseException // The specified resource is in use. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaign -func (c *Personalize) UpdateCampaign(input *UpdateCampaignInput) (*UpdateCampaignOutput, error) { - req, out := c.UpdateCampaignRequest(input) +// - ResourceAlreadyExistsException +// The specified resource already exists. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateMetricAttribution +func (c *Personalize) UpdateMetricAttribution(input *UpdateMetricAttributionInput) (*UpdateMetricAttributionOutput, error) { + req, out := c.UpdateMetricAttributionRequest(input) return out, req.Send() } -// UpdateCampaignWithContext is the same as UpdateCampaign with the addition of +// UpdateMetricAttributionWithContext is the same as UpdateMetricAttribution with the addition of // the ability to pass a context and additional request options. // -// See UpdateCampaign for details on how to use this API operation. +// See UpdateMetricAttribution for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) UpdateCampaignWithContext(ctx aws.Context, input *UpdateCampaignInput, opts ...request.Option) (*UpdateCampaignOutput, error) { - req, out := c.UpdateCampaignRequest(input) +func (c *Personalize) UpdateMetricAttributionWithContext(ctx aws.Context, input *UpdateMetricAttributionInput, opts ...request.Option) (*UpdateMetricAttributionOutput, error) { + req, out := c.UpdateMetricAttributionRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() @@ -8715,6 +9346,10 @@ type CreateDatasetImportJobInput struct { // JobName is a required field JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"` + // If you created a metric attribution, specify whether to publish metrics for + // this import job to Amazon S3 + PublishAttributionMetricsToS3 *bool `locationName:"publishAttributionMetricsToS3" type:"boolean"` + // The ARN of the IAM role that has permissions to read from the Amazon S3 data // source. // @@ -8803,6 +9438,12 @@ func (s *CreateDatasetImportJobInput) SetJobName(v string) *CreateDatasetImportJ return s } +// SetPublishAttributionMetricsToS3 sets the PublishAttributionMetricsToS3 field's value. +func (s *CreateDatasetImportJobInput) SetPublishAttributionMetricsToS3(v bool) *CreateDatasetImportJobInput { + s.PublishAttributionMetricsToS3 = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *CreateDatasetImportJobInput) SetRoleArn(v string) *CreateDatasetImportJobInput { s.RoleArn = &v @@ -9260,6 +9901,147 @@ func (s *CreateFilterOutput) SetFilterArn(v string) *CreateFilterOutput { return s } +type CreateMetricAttributionInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the destination dataset group for the metric + // attribution. + // + // DatasetGroupArn is a required field + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"` + + // A list of metric attributes for the metric attribution. Each metric attribute + // specifies an event type to track and a function. Available functions are + // SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either + // Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE). + // + // Metrics is a required field + Metrics []*MetricAttribute `locationName:"metrics" type:"list" required:"true"` + + // The output configuration details for the metric attribution. + // + // MetricsOutputConfig is a required field + MetricsOutputConfig *MetricAttributionOutput_ `locationName:"metricsOutputConfig" type:"structure" required:"true"` + + // A name for the metric attribution. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMetricAttributionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMetricAttributionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateMetricAttributionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateMetricAttributionInput"} + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) + } + if s.Metrics == nil { + invalidParams.Add(request.NewErrParamRequired("Metrics")) + } + if s.MetricsOutputConfig == nil { + invalidParams.Add(request.NewErrParamRequired("MetricsOutputConfig")) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Metrics != nil { + for i, v := range s.Metrics { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Metrics", i), err.(request.ErrInvalidParams)) + } + } + } + if s.MetricsOutputConfig != nil { + if err := s.MetricsOutputConfig.Validate(); err != nil { + invalidParams.AddNested("MetricsOutputConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *CreateMetricAttributionInput) SetDatasetGroupArn(v string) *CreateMetricAttributionInput { + s.DatasetGroupArn = &v + return s +} + +// SetMetrics sets the Metrics field's value. +func (s *CreateMetricAttributionInput) SetMetrics(v []*MetricAttribute) *CreateMetricAttributionInput { + s.Metrics = v + return s +} + +// SetMetricsOutputConfig sets the MetricsOutputConfig field's value. +func (s *CreateMetricAttributionInput) SetMetricsOutputConfig(v *MetricAttributionOutput_) *CreateMetricAttributionInput { + s.MetricsOutputConfig = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateMetricAttributionInput) SetName(v string) *CreateMetricAttributionInput { + s.Name = &v + return s +} + +type CreateMetricAttributionOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the new metric attribution. + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMetricAttributionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMetricAttributionOutput) GoString() string { + return s.String() +} + +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *CreateMetricAttributionOutput) SetMetricAttributionArn(v string) *CreateMetricAttributionOutput { + s.MetricAttributionArn = &v + return s +} + type CreateRecommenderInput struct { _ struct{} `type:"structure"` @@ -9700,6 +10482,9 @@ func (s *CreateSolutionOutput) SetSolutionArn(v string) *CreateSolutionOutput { type CreateSolutionVersionInput struct { _ struct{} `type:"structure"` + // The name of the solution version. + Name *string `locationName:"name" min:"1" type:"string"` + // The Amazon Resource Name (ARN) of the solution containing the training configuration // information. // @@ -9746,6 +10531,9 @@ func (s CreateSolutionVersionInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateSolutionVersionInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateSolutionVersionInput"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } if s.SolutionArn == nil { invalidParams.Add(request.NewErrParamRequired("SolutionArn")) } @@ -9766,6 +10554,12 @@ func (s *CreateSolutionVersionInput) Validate() error { return nil } +// SetName sets the Name field's value. +func (s *CreateSolutionVersionInput) SetName(v string) *CreateSolutionVersionInput { + s.Name = &v + return s +} + // SetSolutionArn sets the SolutionArn field's value. func (s *CreateSolutionVersionInput) SetSolutionArn(v string) *CreateSolutionVersionInput { s.SolutionArn = &v @@ -10471,6 +11265,9 @@ type DatasetImportJob struct { // The date and time (in Unix time) the dataset was last updated. LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + // Whether the job publishes metrics to Amazon S3 for a metric attribution. + PublishAttributionMetricsToS3 *bool `locationName:"publishAttributionMetricsToS3" type:"boolean"` + // The ARN of the IAM role that has permissions to read from the Amazon S3 data // source. RoleArn *string `locationName:"roleArn" type:"string"` @@ -10549,6 +11346,12 @@ func (s *DatasetImportJob) SetLastUpdatedDateTime(v time.Time) *DatasetImportJob return s } +// SetPublishAttributionMetricsToS3 sets the PublishAttributionMetricsToS3 field's value. +func (s *DatasetImportJob) SetPublishAttributionMetricsToS3(v bool) *DatasetImportJob { + s.PublishAttributionMetricsToS3 = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *DatasetImportJob) SetRoleArn(v string) *DatasetImportJob { s.RoleArn = &v @@ -11463,6 +12266,74 @@ func (s DeleteFilterOutput) GoString() string { return s.String() } +type DeleteMetricAttributionInput struct { + _ struct{} `type:"structure"` + + // The metric attribution's Amazon Resource Name (ARN). + // + // MetricAttributionArn is a required field + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMetricAttributionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMetricAttributionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteMetricAttributionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteMetricAttributionInput"} + if s.MetricAttributionArn == nil { + invalidParams.Add(request.NewErrParamRequired("MetricAttributionArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *DeleteMetricAttributionInput) SetMetricAttributionArn(v string) *DeleteMetricAttributionInput { + s.MetricAttributionArn = &v + return s +} + +type DeleteMetricAttributionOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMetricAttributionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMetricAttributionOutput) GoString() string { + return s.String() +} + type DeleteRecommenderInput struct { _ struct{} `type:"structure"` @@ -12420,17 +13291,94 @@ func (s *DescribeFeatureTransformationInput) Validate() error { return nil } -// SetFeatureTransformationArn sets the FeatureTransformationArn field's value. -func (s *DescribeFeatureTransformationInput) SetFeatureTransformationArn(v string) *DescribeFeatureTransformationInput { - s.FeatureTransformationArn = &v +// SetFeatureTransformationArn sets the FeatureTransformationArn field's value. +func (s *DescribeFeatureTransformationInput) SetFeatureTransformationArn(v string) *DescribeFeatureTransformationInput { + s.FeatureTransformationArn = &v + return s +} + +type DescribeFeatureTransformationOutput struct { + _ struct{} `type:"structure"` + + // A listing of the FeatureTransformation properties. + FeatureTransformation *FeatureTransformation `locationName:"featureTransformation" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFeatureTransformationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFeatureTransformationOutput) GoString() string { + return s.String() +} + +// SetFeatureTransformation sets the FeatureTransformation field's value. +func (s *DescribeFeatureTransformationOutput) SetFeatureTransformation(v *FeatureTransformation) *DescribeFeatureTransformationOutput { + s.FeatureTransformation = v + return s +} + +type DescribeFilterInput struct { + _ struct{} `type:"structure"` + + // The ARN of the filter to describe. + // + // FilterArn is a required field + FilterArn *string `locationName:"filterArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFilterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFilterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFilterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFilterInput"} + if s.FilterArn == nil { + invalidParams.Add(request.NewErrParamRequired("FilterArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilterArn sets the FilterArn field's value. +func (s *DescribeFilterInput) SetFilterArn(v string) *DescribeFilterInput { + s.FilterArn = &v return s } -type DescribeFeatureTransformationOutput struct { +type DescribeFilterOutput struct { _ struct{} `type:"structure"` - // A listing of the FeatureTransformation properties. - FeatureTransformation *FeatureTransformation `locationName:"featureTransformation" type:"structure"` + // The filter's details. + Filter *Filter `locationName:"filter" type:"structure"` } // String returns the string representation. @@ -12438,7 +13386,7 @@ type DescribeFeatureTransformationOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeFeatureTransformationOutput) String() string { +func (s DescribeFilterOutput) String() string { return awsutil.Prettify(s) } @@ -12447,23 +13395,23 @@ func (s DescribeFeatureTransformationOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeFeatureTransformationOutput) GoString() string { +func (s DescribeFilterOutput) GoString() string { return s.String() } -// SetFeatureTransformation sets the FeatureTransformation field's value. -func (s *DescribeFeatureTransformationOutput) SetFeatureTransformation(v *FeatureTransformation) *DescribeFeatureTransformationOutput { - s.FeatureTransformation = v +// SetFilter sets the Filter field's value. +func (s *DescribeFilterOutput) SetFilter(v *Filter) *DescribeFilterOutput { + s.Filter = v return s } -type DescribeFilterInput struct { +type DescribeMetricAttributionInput struct { _ struct{} `type:"structure"` - // The ARN of the filter to describe. + // The metric attribution's Amazon Resource Name (ARN). // - // FilterArn is a required field - FilterArn *string `locationName:"filterArn" type:"string" required:"true"` + // MetricAttributionArn is a required field + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string" required:"true"` } // String returns the string representation. @@ -12471,7 +13419,7 @@ type DescribeFilterInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeFilterInput) String() string { +func (s DescribeMetricAttributionInput) String() string { return awsutil.Prettify(s) } @@ -12480,15 +13428,15 @@ func (s DescribeFilterInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeFilterInput) GoString() string { +func (s DescribeMetricAttributionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeFilterInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeFilterInput"} - if s.FilterArn == nil { - invalidParams.Add(request.NewErrParamRequired("FilterArn")) +func (s *DescribeMetricAttributionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeMetricAttributionInput"} + if s.MetricAttributionArn == nil { + invalidParams.Add(request.NewErrParamRequired("MetricAttributionArn")) } if invalidParams.Len() > 0 { @@ -12497,17 +13445,17 @@ func (s *DescribeFilterInput) Validate() error { return nil } -// SetFilterArn sets the FilterArn field's value. -func (s *DescribeFilterInput) SetFilterArn(v string) *DescribeFilterInput { - s.FilterArn = &v +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *DescribeMetricAttributionInput) SetMetricAttributionArn(v string) *DescribeMetricAttributionInput { + s.MetricAttributionArn = &v return s } -type DescribeFilterOutput struct { +type DescribeMetricAttributionOutput struct { _ struct{} `type:"structure"` - // The filter's details. - Filter *Filter `locationName:"filter" type:"structure"` + // The details of the metric attribution. + MetricAttribution *MetricAttribution `locationName:"metricAttribution" type:"structure"` } // String returns the string representation. @@ -12515,7 +13463,7 @@ type DescribeFilterOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeFilterOutput) String() string { +func (s DescribeMetricAttributionOutput) String() string { return awsutil.Prettify(s) } @@ -12524,13 +13472,13 @@ func (s DescribeFilterOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeFilterOutput) GoString() string { +func (s DescribeMetricAttributionOutput) GoString() string { return s.String() } -// SetFilter sets the Filter field's value. -func (s *DescribeFilterOutput) SetFilter(v *Filter) *DescribeFilterOutput { - s.Filter = v +// SetMetricAttribution sets the MetricAttribution field's value. +func (s *DescribeMetricAttributionOutput) SetMetricAttribution(v *MetricAttribution) *DescribeMetricAttributionOutput { + s.MetricAttribution = v return s } @@ -14618,30 +15566,236 @@ func (s *ListDatasetsInput) Validate() error { } // SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *ListDatasetsInput) SetDatasetGroupArn(v string) *ListDatasetsInput { +func (s *ListDatasetsInput) SetDatasetGroupArn(v string) *ListDatasetsInput { + s.DatasetGroupArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { + s.NextToken = &v + return s +} + +type ListDatasetsOutput struct { + _ struct{} `type:"structure"` + + // An array of Dataset objects. Each object provides metadata information. + Datasets []*DatasetSummary `locationName:"datasets" type:"list"` + + // A token for getting the next set of datasets (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetsOutput) GoString() string { + return s.String() +} + +// SetDatasets sets the Datasets field's value. +func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput { + s.Datasets = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { + s.NextToken = &v + return s +} + +type ListEventTrackersInput struct { + _ struct{} `type:"structure"` + + // The ARN of a dataset group used to filter the response. + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // The maximum number of event trackers to return. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // A token returned from the previous call to ListEventTrackers for getting + // the next set of event trackers (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventTrackersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventTrackersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListEventTrackersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEventTrackersInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *ListEventTrackersInput) SetDatasetGroupArn(v string) *ListEventTrackersInput { + s.DatasetGroupArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListEventTrackersInput) SetMaxResults(v int64) *ListEventTrackersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEventTrackersInput) SetNextToken(v string) *ListEventTrackersInput { + s.NextToken = &v + return s +} + +type ListEventTrackersOutput struct { + _ struct{} `type:"structure"` + + // A list of event trackers. + EventTrackers []*EventTrackerSummary `locationName:"eventTrackers" type:"list"` + + // A token for getting the next set of event trackers (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventTrackersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventTrackersOutput) GoString() string { + return s.String() +} + +// SetEventTrackers sets the EventTrackers field's value. +func (s *ListEventTrackersOutput) SetEventTrackers(v []*EventTrackerSummary) *ListEventTrackersOutput { + s.EventTrackers = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEventTrackersOutput) SetNextToken(v string) *ListEventTrackersOutput { + s.NextToken = &v + return s +} + +type ListFiltersInput struct { + _ struct{} `type:"structure"` + + // The ARN of the dataset group that contains the filters. + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // The maximum number of filters to return. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // A token returned from the previous call to ListFilters for getting the next + // set of filters (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFiltersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFiltersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFiltersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFiltersInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *ListFiltersInput) SetDatasetGroupArn(v string) *ListFiltersInput { s.DatasetGroupArn = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { +func (s *ListFiltersInput) SetMaxResults(v int64) *ListFiltersInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { +func (s *ListFiltersInput) SetNextToken(v string) *ListFiltersInput { s.NextToken = &v return s } -type ListDatasetsOutput struct { +type ListFiltersOutput struct { _ struct{} `type:"structure"` - // An array of Dataset objects. Each object provides metadata information. - Datasets []*DatasetSummary `locationName:"datasets" type:"list"` + // A list of returned filters. + Filters []*FilterSummary `type:"list"` - // A token for getting the next set of datasets (if they exist). + // A token for getting the next set of filters (if they exist). NextToken *string `locationName:"nextToken" type:"string"` } @@ -14650,7 +15804,7 @@ type ListDatasetsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetsOutput) String() string { +func (s ListFiltersOutput) String() string { return awsutil.Prettify(s) } @@ -14659,33 +15813,34 @@ func (s ListDatasetsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetsOutput) GoString() string { +func (s ListFiltersOutput) GoString() string { return s.String() } -// SetDatasets sets the Datasets field's value. -func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput { - s.Datasets = v +// SetFilters sets the Filters field's value. +func (s *ListFiltersOutput) SetFilters(v []*FilterSummary) *ListFiltersOutput { + s.Filters = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { +func (s *ListFiltersOutput) SetNextToken(v string) *ListFiltersOutput { s.NextToken = &v return s } -type ListEventTrackersInput struct { +type ListMetricAttributionMetricsInput struct { _ struct{} `type:"structure"` - // The ARN of a dataset group used to filter the response. - DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` - - // The maximum number of event trackers to return. + // The maximum number of metrics to return in one page of results. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // A token returned from the previous call to ListEventTrackers for getting - // the next set of event trackers (if they exist). + // The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes + // for. + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -14694,7 +15849,7 @@ type ListEventTrackersInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListEventTrackersInput) String() string { +func (s ListMetricAttributionMetricsInput) String() string { return awsutil.Prettify(s) } @@ -14703,13 +15858,13 @@ func (s ListEventTrackersInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListEventTrackersInput) GoString() string { +func (s ListMetricAttributionMetricsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListEventTrackersInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListEventTrackersInput"} +func (s *ListMetricAttributionMetricsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMetricAttributionMetricsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -14720,31 +15875,32 @@ func (s *ListEventTrackersInput) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *ListEventTrackersInput) SetDatasetGroupArn(v string) *ListEventTrackersInput { - s.DatasetGroupArn = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListMetricAttributionMetricsInput) SetMaxResults(v int64) *ListMetricAttributionMetricsInput { + s.MaxResults = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListEventTrackersInput) SetMaxResults(v int64) *ListEventTrackersInput { - s.MaxResults = &v +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *ListMetricAttributionMetricsInput) SetMetricAttributionArn(v string) *ListMetricAttributionMetricsInput { + s.MetricAttributionArn = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListEventTrackersInput) SetNextToken(v string) *ListEventTrackersInput { +func (s *ListMetricAttributionMetricsInput) SetNextToken(v string) *ListMetricAttributionMetricsInput { s.NextToken = &v return s } -type ListEventTrackersOutput struct { +type ListMetricAttributionMetricsOutput struct { _ struct{} `type:"structure"` - // A list of event trackers. - EventTrackers []*EventTrackerSummary `locationName:"eventTrackers" type:"list"` + // The metrics for the specified metric attribution. + Metrics []*MetricAttribute `locationName:"metrics" type:"list"` - // A token for getting the next set of event trackers (if they exist). + // Specify the pagination token from a previous ListMetricAttributionMetricsResponse + // request to retrieve the next page of results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -14753,7 +15909,7 @@ type ListEventTrackersOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListEventTrackersOutput) String() string { +func (s ListMetricAttributionMetricsOutput) String() string { return awsutil.Prettify(s) } @@ -14762,33 +15918,33 @@ func (s ListEventTrackersOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListEventTrackersOutput) GoString() string { +func (s ListMetricAttributionMetricsOutput) GoString() string { return s.String() } -// SetEventTrackers sets the EventTrackers field's value. -func (s *ListEventTrackersOutput) SetEventTrackers(v []*EventTrackerSummary) *ListEventTrackersOutput { - s.EventTrackers = v +// SetMetrics sets the Metrics field's value. +func (s *ListMetricAttributionMetricsOutput) SetMetrics(v []*MetricAttribute) *ListMetricAttributionMetricsOutput { + s.Metrics = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListEventTrackersOutput) SetNextToken(v string) *ListEventTrackersOutput { +func (s *ListMetricAttributionMetricsOutput) SetNextToken(v string) *ListMetricAttributionMetricsOutput { s.NextToken = &v return s } -type ListFiltersInput struct { +type ListMetricAttributionsInput struct { _ struct{} `type:"structure"` - // The ARN of the dataset group that contains the filters. + // The metric attributions' dataset group Amazon Resource Name (ARN). DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` - // The maximum number of filters to return. + // The maximum number of metric attributions to return in one page of results. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // A token returned from the previous call to ListFilters for getting the next - // set of filters (if they exist). + // Specify the pagination token from a previous request to retrieve the next + // page of results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -14797,7 +15953,7 @@ type ListFiltersInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListFiltersInput) String() string { +func (s ListMetricAttributionsInput) String() string { return awsutil.Prettify(s) } @@ -14806,13 +15962,13 @@ func (s ListFiltersInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListFiltersInput) GoString() string { +func (s ListMetricAttributionsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListFiltersInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListFiltersInput"} +func (s *ListMetricAttributionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMetricAttributionsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -14824,30 +15980,31 @@ func (s *ListFiltersInput) Validate() error { } // SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *ListFiltersInput) SetDatasetGroupArn(v string) *ListFiltersInput { +func (s *ListMetricAttributionsInput) SetDatasetGroupArn(v string) *ListMetricAttributionsInput { s.DatasetGroupArn = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListFiltersInput) SetMaxResults(v int64) *ListFiltersInput { +func (s *ListMetricAttributionsInput) SetMaxResults(v int64) *ListMetricAttributionsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListFiltersInput) SetNextToken(v string) *ListFiltersInput { +func (s *ListMetricAttributionsInput) SetNextToken(v string) *ListMetricAttributionsInput { s.NextToken = &v return s } -type ListFiltersOutput struct { +type ListMetricAttributionsOutput struct { _ struct{} `type:"structure"` - // A list of returned filters. - Filters []*FilterSummary `type:"list"` + // The list of metric attributions. + MetricAttributions []*MetricAttributionSummary `locationName:"metricAttributions" type:"list"` - // A token for getting the next set of filters (if they exist). + // Specify the pagination token from a previous request to retrieve the next + // page of results. NextToken *string `locationName:"nextToken" type:"string"` } @@ -14856,7 +16013,7 @@ type ListFiltersOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListFiltersOutput) String() string { +func (s ListMetricAttributionsOutput) String() string { return awsutil.Prettify(s) } @@ -14865,18 +16022,18 @@ func (s ListFiltersOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListFiltersOutput) GoString() string { +func (s ListMetricAttributionsOutput) GoString() string { return s.String() } -// SetFilters sets the Filters field's value. -func (s *ListFiltersOutput) SetFilters(v []*FilterSummary) *ListFiltersOutput { - s.Filters = v +// SetMetricAttributions sets the MetricAttributions field's value. +func (s *ListMetricAttributionsOutput) SetMetricAttributions(v []*MetricAttributionSummary) *ListMetricAttributionsOutput { + s.MetricAttributions = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListFiltersOutput) SetNextToken(v string) *ListFiltersOutput { +func (s *ListMetricAttributionsOutput) SetNextToken(v string) *ListMetricAttributionsOutput { s.NextToken = &v return s } @@ -15297,18 +16454,208 @@ func (s *ListSolutionVersionsOutput) SetSolutionVersions(v []*SolutionVersionSum return s } -type ListSolutionsInput struct { +type ListSolutionsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset group. + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // The maximum number of solutions to return. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // A token returned from the previous call to ListSolutions for getting the + // next set of solutions (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSolutionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSolutionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSolutionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSolutionsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *ListSolutionsInput) SetDatasetGroupArn(v string) *ListSolutionsInput { + s.DatasetGroupArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSolutionsInput) SetMaxResults(v int64) *ListSolutionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSolutionsInput) SetNextToken(v string) *ListSolutionsInput { + s.NextToken = &v + return s +} + +type ListSolutionsOutput struct { + _ struct{} `type:"structure"` + + // A token for getting the next set of solutions (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` + + // A list of the current solutions. + Solutions []*SolutionSummary `locationName:"solutions" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSolutionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSolutionsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSolutionsOutput) SetNextToken(v string) *ListSolutionsOutput { + s.NextToken = &v + return s +} + +// SetSolutions sets the Solutions field's value. +func (s *ListSolutionsOutput) SetSolutions(v []*SolutionSummary) *ListSolutionsOutput { + s.Solutions = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The resource's Amazon Resource Name. + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The resource's tags. + Tags []*Tag `locationName:"tags" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// Contains information on a metric that a metric attribution reports on. For +// more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +type MetricAttribute struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset group. - DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + // The metric's event type. + // + // EventType is a required field + EventType *string `locationName:"eventType" type:"string" required:"true"` - // The maximum number of solutions to return. - MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + // The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). + // For SUM() functions, provide the dataset type (either Interactions or Items) + // and column to sum as a parameter. For example SUM(Items.PRICE). + // + // Expression is a required field + Expression *string `locationName:"expression" type:"string" required:"true"` - // A token returned from the previous call to ListSolutions for getting the - // next set of solutions (if they exist). - NextToken *string `locationName:"nextToken" type:"string"` + // The metric's name. The name helps you identify the metric in Amazon CloudWatch + // or Amazon S3. + // + // MetricName is a required field + MetricName *string `locationName:"metricName" type:"string" required:"true"` } // String returns the string representation. @@ -15316,7 +16663,7 @@ type ListSolutionsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListSolutionsInput) String() string { +func (s MetricAttribute) String() string { return awsutil.Prettify(s) } @@ -15325,15 +16672,21 @@ func (s ListSolutionsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListSolutionsInput) GoString() string { +func (s MetricAttribute) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListSolutionsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListSolutionsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *MetricAttribute) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MetricAttribute"} + if s.EventType == nil { + invalidParams.Add(request.NewErrParamRequired("EventType")) + } + if s.Expression == nil { + invalidParams.Add(request.NewErrParamRequired("Expression")) + } + if s.MetricName == nil { + invalidParams.Add(request.NewErrParamRequired("MetricName")) } if invalidParams.Len() > 0 { @@ -15342,32 +16695,54 @@ func (s *ListSolutionsInput) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *ListSolutionsInput) SetDatasetGroupArn(v string) *ListSolutionsInput { - s.DatasetGroupArn = &v +// SetEventType sets the EventType field's value. +func (s *MetricAttribute) SetEventType(v string) *MetricAttribute { + s.EventType = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListSolutionsInput) SetMaxResults(v int64) *ListSolutionsInput { - s.MaxResults = &v +// SetExpression sets the Expression field's value. +func (s *MetricAttribute) SetExpression(v string) *MetricAttribute { + s.Expression = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListSolutionsInput) SetNextToken(v string) *ListSolutionsInput { - s.NextToken = &v +// SetMetricName sets the MetricName field's value. +func (s *MetricAttribute) SetMetricName(v string) *MetricAttribute { + s.MetricName = &v return s } -type ListSolutionsOutput struct { +// Contains information on a metric attribution. A metric attribution creates +// reports on the data that you import into Amazon Personalize. Depending on +// how you import the data, you can view reports in Amazon CloudWatch or Amazon +// S3. For more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +type MetricAttribution struct { _ struct{} `type:"structure"` - // A token for getting the next set of solutions (if they exist). - NextToken *string `locationName:"nextToken" type:"string"` + // The metric attribution's creation date time. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` - // A list of the current solutions. - Solutions []*SolutionSummary `locationName:"solutions" type:"list"` + // The metric attribution's dataset group Amazon Resource Name (ARN). + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // The metric attribution's failure reason. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The metric attribution's last updated date time. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The metric attribution's Amazon Resource Name (ARN). + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string"` + + // The metric attribution's output configuration. + MetricsOutputConfig *MetricAttributionOutput_ `locationName:"metricsOutputConfig" type:"structure"` + + // The metric attribution's name. + Name *string `locationName:"name" min:"1" type:"string"` + + // The metric attribution's status. + Status *string `locationName:"status" type:"string"` } // String returns the string representation. @@ -15375,7 +16750,7 @@ type ListSolutionsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListSolutionsOutput) String() string { +func (s MetricAttribution) String() string { return awsutil.Prettify(s) } @@ -15384,29 +16759,71 @@ func (s ListSolutionsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListSolutionsOutput) GoString() string { +func (s MetricAttribution) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListSolutionsOutput) SetNextToken(v string) *ListSolutionsOutput { - s.NextToken = &v +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *MetricAttribution) SetCreationDateTime(v time.Time) *MetricAttribution { + s.CreationDateTime = &v return s } -// SetSolutions sets the Solutions field's value. -func (s *ListSolutionsOutput) SetSolutions(v []*SolutionSummary) *ListSolutionsOutput { - s.Solutions = v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *MetricAttribution) SetDatasetGroupArn(v string) *MetricAttribution { + s.DatasetGroupArn = &v return s } -type ListTagsForResourceInput struct { +// SetFailureReason sets the FailureReason field's value. +func (s *MetricAttribution) SetFailureReason(v string) *MetricAttribution { + s.FailureReason = &v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *MetricAttribution) SetLastUpdatedDateTime(v time.Time) *MetricAttribution { + s.LastUpdatedDateTime = &v + return s +} + +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *MetricAttribution) SetMetricAttributionArn(v string) *MetricAttribution { + s.MetricAttributionArn = &v + return s +} + +// SetMetricsOutputConfig sets the MetricsOutputConfig field's value. +func (s *MetricAttribution) SetMetricsOutputConfig(v *MetricAttributionOutput_) *MetricAttribution { + s.MetricsOutputConfig = v + return s +} + +// SetName sets the Name field's value. +func (s *MetricAttribution) SetName(v string) *MetricAttribution { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *MetricAttribution) SetStatus(v string) *MetricAttribution { + s.Status = &v + return s +} + +// The output configuration details for a metric attribution. +type MetricAttributionOutput_ struct { _ struct{} `type:"structure"` - // The resource's Amazon Resource Name. + // The Amazon Resource Name (ARN) of the IAM service role that has permissions + // to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. + // For more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). // - // ResourceArn is a required field - ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` + // RoleArn is a required field + RoleArn *string `locationName:"roleArn" type:"string" required:"true"` + + // The configuration details of an Amazon S3 input or output bucket. + S3DataDestination *S3DataConfig `locationName:"s3DataDestination" type:"structure"` } // String returns the string representation. @@ -15414,7 +16831,7 @@ type ListTagsForResourceInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceInput) String() string { +func (s MetricAttributionOutput_) String() string { return awsutil.Prettify(s) } @@ -15423,15 +16840,20 @@ func (s ListTagsForResourceInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceInput) GoString() string { +func (s MetricAttributionOutput_) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListTagsForResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) +func (s *MetricAttributionOutput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MetricAttributionOutput_"} + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.S3DataDestination != nil { + if err := s.S3DataDestination.Validate(); err != nil { + invalidParams.AddNested("S3DataDestination", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -15440,17 +16862,40 @@ func (s *ListTagsForResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { - s.ResourceArn = &v +// SetRoleArn sets the RoleArn field's value. +func (s *MetricAttributionOutput_) SetRoleArn(v string) *MetricAttributionOutput_ { + s.RoleArn = &v return s } -type ListTagsForResourceOutput struct { +// SetS3DataDestination sets the S3DataDestination field's value. +func (s *MetricAttributionOutput_) SetS3DataDestination(v *S3DataConfig) *MetricAttributionOutput_ { + s.S3DataDestination = v + return s +} + +// Provides a summary of the properties of a metric attribution. For a complete +// listing, call the DescribeMetricAttribution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html). +type MetricAttributionSummary struct { _ struct{} `type:"structure"` - // The resource's tags. - Tags []*Tag `locationName:"tags" type:"list"` + // The metric attribution's creation date time. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The metric attribution's failure reason. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The metric attribution's last updated date time. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The metric attribution's Amazon Resource Name (ARN). + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string"` + + // The name of the metric attribution. + Name *string `locationName:"name" min:"1" type:"string"` + + // The metric attribution's status. + Status *string `locationName:"status" type:"string"` } // String returns the string representation. @@ -15458,7 +16903,7 @@ type ListTagsForResourceOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceOutput) String() string { +func (s MetricAttributionSummary) String() string { return awsutil.Prettify(s) } @@ -15467,13 +16912,43 @@ func (s ListTagsForResourceOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceOutput) GoString() string { +func (s MetricAttributionSummary) GoString() string { return s.String() } -// SetTags sets the Tags field's value. -func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { - s.Tags = v +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *MetricAttributionSummary) SetCreationDateTime(v time.Time) *MetricAttributionSummary { + s.CreationDateTime = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *MetricAttributionSummary) SetFailureReason(v string) *MetricAttributionSummary { + s.FailureReason = &v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *MetricAttributionSummary) SetLastUpdatedDateTime(v time.Time) *MetricAttributionSummary { + s.LastUpdatedDateTime = &v + return s +} + +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *MetricAttributionSummary) SetMetricAttributionArn(v string) *MetricAttributionSummary { + s.MetricAttributionArn = &v + return s +} + +// SetName sets the Name field's value. +func (s *MetricAttributionSummary) SetName(v string) *MetricAttributionSummary { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *MetricAttributionSummary) SetStatus(v string) *MetricAttributionSummary { + s.Status = &v return s } @@ -16629,6 +18104,9 @@ type SolutionSummary struct { // The name of the solution. Name *string `locationName:"name" min:"1" type:"string"` + // The Amazon Resource Name (ARN) of the recipe used by the solution. + RecipeArn *string `locationName:"recipeArn" type:"string"` + // The Amazon Resource Name (ARN) of the solution. SolutionArn *string `locationName:"solutionArn" type:"string"` @@ -16678,6 +18156,12 @@ func (s *SolutionSummary) SetName(v string) *SolutionSummary { return s } +// SetRecipeArn sets the RecipeArn field's value. +func (s *SolutionSummary) SetRecipeArn(v string) *SolutionSummary { + s.RecipeArn = &v + return s +} + // SetSolutionArn sets the SolutionArn field's value. func (s *SolutionSummary) SetSolutionArn(v string) *SolutionSummary { s.SolutionArn = &v @@ -16713,6 +18197,9 @@ type SolutionVersion struct { // The date and time (in Unix time) that the solution was last updated. LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + // The name of the solution version. + Name *string `locationName:"name" min:"1" type:"string"` + // When true, Amazon Personalize searches for the most optimal recipe according // to the solution configuration. When false (the default), Amazon Personalize // uses recipeArn. @@ -16823,6 +18310,12 @@ func (s *SolutionVersion) SetLastUpdatedDateTime(v time.Time) *SolutionVersion { return s } +// SetName sets the Name field's value. +func (s *SolutionVersion) SetName(v string) *SolutionVersion { + s.Name = &v + return s +} + // SetPerformAutoML sets the PerformAutoML field's value. func (s *SolutionVersion) SetPerformAutoML(v bool) *SolutionVersion { s.PerformAutoML = &v @@ -17693,6 +19186,120 @@ func (s *UpdateCampaignOutput) SetCampaignArn(v string) *UpdateCampaignOutput { return s } +type UpdateMetricAttributionInput struct { + _ struct{} `type:"structure"` + + // Add new metric attributes to the metric attribution. + AddMetrics []*MetricAttribute `locationName:"addMetrics" type:"list"` + + // The Amazon Resource Name (ARN) for the metric attribution to update. + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string"` + + // An output config for the metric attribution. + MetricsOutputConfig *MetricAttributionOutput_ `locationName:"metricsOutputConfig" type:"structure"` + + // Remove metric attributes from the metric attribution. + RemoveMetrics []*string `locationName:"removeMetrics" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMetricAttributionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMetricAttributionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateMetricAttributionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateMetricAttributionInput"} + if s.AddMetrics != nil { + for i, v := range s.AddMetrics { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AddMetrics", i), err.(request.ErrInvalidParams)) + } + } + } + if s.MetricsOutputConfig != nil { + if err := s.MetricsOutputConfig.Validate(); err != nil { + invalidParams.AddNested("MetricsOutputConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAddMetrics sets the AddMetrics field's value. +func (s *UpdateMetricAttributionInput) SetAddMetrics(v []*MetricAttribute) *UpdateMetricAttributionInput { + s.AddMetrics = v + return s +} + +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *UpdateMetricAttributionInput) SetMetricAttributionArn(v string) *UpdateMetricAttributionInput { + s.MetricAttributionArn = &v + return s +} + +// SetMetricsOutputConfig sets the MetricsOutputConfig field's value. +func (s *UpdateMetricAttributionInput) SetMetricsOutputConfig(v *MetricAttributionOutput_) *UpdateMetricAttributionInput { + s.MetricsOutputConfig = v + return s +} + +// SetRemoveMetrics sets the RemoveMetrics field's value. +func (s *UpdateMetricAttributionInput) SetRemoveMetrics(v []*string) *UpdateMetricAttributionInput { + s.RemoveMetrics = v + return s +} + +type UpdateMetricAttributionOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the metric attribution that you updated. + MetricAttributionArn *string `locationName:"metricAttributionArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMetricAttributionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMetricAttributionOutput) GoString() string { + return s.String() +} + +// SetMetricAttributionArn sets the MetricAttributionArn field's value. +func (s *UpdateMetricAttributionOutput) SetMetricAttributionArn(v string) *UpdateMetricAttributionOutput { + s.MetricAttributionArn = &v + return s +} + type UpdateRecommenderInput struct { _ struct{} `type:"structure"` diff --git a/service/personalize/personalizeiface/interface.go b/service/personalize/personalizeiface/interface.go index 41b9b9e762a..2cd4407c882 100644 --- a/service/personalize/personalizeiface/interface.go +++ b/service/personalize/personalizeiface/interface.go @@ -96,6 +96,10 @@ type PersonalizeAPI interface { CreateFilterWithContext(aws.Context, *personalize.CreateFilterInput, ...request.Option) (*personalize.CreateFilterOutput, error) CreateFilterRequest(*personalize.CreateFilterInput) (*request.Request, *personalize.CreateFilterOutput) + CreateMetricAttribution(*personalize.CreateMetricAttributionInput) (*personalize.CreateMetricAttributionOutput, error) + CreateMetricAttributionWithContext(aws.Context, *personalize.CreateMetricAttributionInput, ...request.Option) (*personalize.CreateMetricAttributionOutput, error) + CreateMetricAttributionRequest(*personalize.CreateMetricAttributionInput) (*request.Request, *personalize.CreateMetricAttributionOutput) + CreateRecommender(*personalize.CreateRecommenderInput) (*personalize.CreateRecommenderOutput, error) CreateRecommenderWithContext(aws.Context, *personalize.CreateRecommenderInput, ...request.Option) (*personalize.CreateRecommenderOutput, error) CreateRecommenderRequest(*personalize.CreateRecommenderInput) (*request.Request, *personalize.CreateRecommenderOutput) @@ -132,6 +136,10 @@ type PersonalizeAPI interface { DeleteFilterWithContext(aws.Context, *personalize.DeleteFilterInput, ...request.Option) (*personalize.DeleteFilterOutput, error) DeleteFilterRequest(*personalize.DeleteFilterInput) (*request.Request, *personalize.DeleteFilterOutput) + DeleteMetricAttribution(*personalize.DeleteMetricAttributionInput) (*personalize.DeleteMetricAttributionOutput, error) + DeleteMetricAttributionWithContext(aws.Context, *personalize.DeleteMetricAttributionInput, ...request.Option) (*personalize.DeleteMetricAttributionOutput, error) + DeleteMetricAttributionRequest(*personalize.DeleteMetricAttributionInput) (*request.Request, *personalize.DeleteMetricAttributionOutput) + DeleteRecommender(*personalize.DeleteRecommenderInput) (*personalize.DeleteRecommenderOutput, error) DeleteRecommenderWithContext(aws.Context, *personalize.DeleteRecommenderInput, ...request.Option) (*personalize.DeleteRecommenderOutput, error) DeleteRecommenderRequest(*personalize.DeleteRecommenderInput) (*request.Request, *personalize.DeleteRecommenderOutput) @@ -188,6 +196,10 @@ type PersonalizeAPI interface { DescribeFilterWithContext(aws.Context, *personalize.DescribeFilterInput, ...request.Option) (*personalize.DescribeFilterOutput, error) DescribeFilterRequest(*personalize.DescribeFilterInput) (*request.Request, *personalize.DescribeFilterOutput) + DescribeMetricAttribution(*personalize.DescribeMetricAttributionInput) (*personalize.DescribeMetricAttributionOutput, error) + DescribeMetricAttributionWithContext(aws.Context, *personalize.DescribeMetricAttributionInput, ...request.Option) (*personalize.DescribeMetricAttributionOutput, error) + DescribeMetricAttributionRequest(*personalize.DescribeMetricAttributionInput) (*request.Request, *personalize.DescribeMetricAttributionOutput) + DescribeRecipe(*personalize.DescribeRecipeInput) (*personalize.DescribeRecipeOutput, error) DescribeRecipeWithContext(aws.Context, *personalize.DescribeRecipeInput, ...request.Option) (*personalize.DescribeRecipeOutput, error) DescribeRecipeRequest(*personalize.DescribeRecipeInput) (*request.Request, *personalize.DescribeRecipeOutput) @@ -275,6 +287,20 @@ type PersonalizeAPI interface { ListFiltersPages(*personalize.ListFiltersInput, func(*personalize.ListFiltersOutput, bool) bool) error ListFiltersPagesWithContext(aws.Context, *personalize.ListFiltersInput, func(*personalize.ListFiltersOutput, bool) bool, ...request.Option) error + ListMetricAttributionMetrics(*personalize.ListMetricAttributionMetricsInput) (*personalize.ListMetricAttributionMetricsOutput, error) + ListMetricAttributionMetricsWithContext(aws.Context, *personalize.ListMetricAttributionMetricsInput, ...request.Option) (*personalize.ListMetricAttributionMetricsOutput, error) + ListMetricAttributionMetricsRequest(*personalize.ListMetricAttributionMetricsInput) (*request.Request, *personalize.ListMetricAttributionMetricsOutput) + + ListMetricAttributionMetricsPages(*personalize.ListMetricAttributionMetricsInput, func(*personalize.ListMetricAttributionMetricsOutput, bool) bool) error + ListMetricAttributionMetricsPagesWithContext(aws.Context, *personalize.ListMetricAttributionMetricsInput, func(*personalize.ListMetricAttributionMetricsOutput, bool) bool, ...request.Option) error + + ListMetricAttributions(*personalize.ListMetricAttributionsInput) (*personalize.ListMetricAttributionsOutput, error) + ListMetricAttributionsWithContext(aws.Context, *personalize.ListMetricAttributionsInput, ...request.Option) (*personalize.ListMetricAttributionsOutput, error) + ListMetricAttributionsRequest(*personalize.ListMetricAttributionsInput) (*request.Request, *personalize.ListMetricAttributionsOutput) + + ListMetricAttributionsPages(*personalize.ListMetricAttributionsInput, func(*personalize.ListMetricAttributionsOutput, bool) bool) error + ListMetricAttributionsPagesWithContext(aws.Context, *personalize.ListMetricAttributionsInput, func(*personalize.ListMetricAttributionsOutput, bool) bool, ...request.Option) error + ListRecipes(*personalize.ListRecipesInput) (*personalize.ListRecipesOutput, error) ListRecipesWithContext(aws.Context, *personalize.ListRecipesInput, ...request.Option) (*personalize.ListRecipesOutput, error) ListRecipesRequest(*personalize.ListRecipesInput) (*request.Request, *personalize.ListRecipesOutput) @@ -338,6 +364,10 @@ type PersonalizeAPI interface { UpdateCampaignWithContext(aws.Context, *personalize.UpdateCampaignInput, ...request.Option) (*personalize.UpdateCampaignOutput, error) UpdateCampaignRequest(*personalize.UpdateCampaignInput) (*request.Request, *personalize.UpdateCampaignOutput) + UpdateMetricAttribution(*personalize.UpdateMetricAttributionInput) (*personalize.UpdateMetricAttributionOutput, error) + UpdateMetricAttributionWithContext(aws.Context, *personalize.UpdateMetricAttributionInput, ...request.Option) (*personalize.UpdateMetricAttributionOutput, error) + UpdateMetricAttributionRequest(*personalize.UpdateMetricAttributionInput) (*request.Request, *personalize.UpdateMetricAttributionOutput) + UpdateRecommender(*personalize.UpdateRecommenderInput) (*personalize.UpdateRecommenderOutput, error) UpdateRecommenderWithContext(aws.Context, *personalize.UpdateRecommenderInput, ...request.Option) (*personalize.UpdateRecommenderOutput, error) UpdateRecommenderRequest(*personalize.UpdateRecommenderInput) (*request.Request, *personalize.UpdateRecommenderOutput) diff --git a/service/polly/api.go b/service/polly/api.go index 6ad834326f8..2280298b62d 100644 --- a/service/polly/api.go +++ b/service/polly/api.go @@ -3986,6 +3986,9 @@ const ( // LanguageCodeYueCn is a LanguageCode enum value LanguageCodeYueCn = "yue-CN" + + // LanguageCodeArAe is a LanguageCode enum value + LanguageCodeArAe = "ar-AE" ) // LanguageCode_Values returns all elements of the LanguageCode enum @@ -4025,6 +4028,7 @@ func LanguageCode_Values() []string { LanguageCodeCaEs, LanguageCodeDeAt, LanguageCodeYueCn, + LanguageCodeArAe, } } @@ -4347,6 +4351,12 @@ const ( // VoiceIdSuvi is a VoiceId enum value VoiceIdSuvi = "Suvi" + + // VoiceIdOla is a VoiceId enum value + VoiceIdOla = "Ola" + + // VoiceIdHala is a VoiceId enum value + VoiceIdHala = "Hala" ) // VoiceId_Values returns all elements of the VoiceId enum @@ -4429,5 +4439,7 @@ func VoiceId_Values() []string { VoiceIdElin, VoiceIdIda, VoiceIdSuvi, + VoiceIdOla, + VoiceIdHala, } } diff --git a/service/s3control/api.go b/service/s3control/api.go index 7f28e97a486..cbe7d702b20 100644 --- a/service/s3control/api.go +++ b/service/s3control/api.go @@ -3590,6 +3590,8 @@ func (c *S3Control) GetStorageLensConfigurationRequest(input *GetStorageLensConf // // Gets the Amazon S3 Storage Lens configuration. For more information, see // Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. // // To use this action, you must have permission to perform the s3:GetStorageLensConfiguration @@ -5702,6 +5704,8 @@ func (c *S3Control) PutStorageLensConfigurationRequest(input *PutStorageLensConf // // Puts an Amazon S3 Storage Lens configuration. For more information about // S3 Storage Lens, see Working with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. // // To use this action, you must have permission to perform the s3:PutStorageLensConfiguration @@ -6144,17 +6148,32 @@ func (s *AccessPoint) SetVpcConfiguration(v *VpcConfiguration) *AccessPoint { return s } -// A container for the account level Amazon S3 Storage Lens configuration. +// A container for the account-level Amazon S3 Storage Lens configuration. +// +// For more information about S3 Storage Lens, see Assessing your storage activity +// and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// in the Amazon S3 User Guide. type AccountLevel struct { _ struct{} `type:"structure"` - // A container for the S3 Storage Lens activity metrics. + // A container for S3 Storage Lens activity metrics. ActivityMetrics *ActivityMetrics `type:"structure"` + // A container for S3 Storage Lens advanced cost-optimization metrics. + AdvancedCostOptimizationMetrics *AdvancedCostOptimizationMetrics `type:"structure"` + + // A container for S3 Storage Lens advanced data-protection metrics. + AdvancedDataProtectionMetrics *AdvancedDataProtectionMetrics `type:"structure"` + // A container for the S3 Storage Lens bucket-level configuration. // // BucketLevel is a required field BucketLevel *BucketLevel `type:"structure" required:"true"` + + // A container for detailed status code metrics. + DetailedStatusCodesMetrics *DetailedStatusCodesMetrics `type:"structure"` } // String returns the string representation. @@ -6199,17 +6218,44 @@ func (s *AccountLevel) SetActivityMetrics(v *ActivityMetrics) *AccountLevel { return s } +// SetAdvancedCostOptimizationMetrics sets the AdvancedCostOptimizationMetrics field's value. +func (s *AccountLevel) SetAdvancedCostOptimizationMetrics(v *AdvancedCostOptimizationMetrics) *AccountLevel { + s.AdvancedCostOptimizationMetrics = v + return s +} + +// SetAdvancedDataProtectionMetrics sets the AdvancedDataProtectionMetrics field's value. +func (s *AccountLevel) SetAdvancedDataProtectionMetrics(v *AdvancedDataProtectionMetrics) *AccountLevel { + s.AdvancedDataProtectionMetrics = v + return s +} + // SetBucketLevel sets the BucketLevel field's value. func (s *AccountLevel) SetBucketLevel(v *BucketLevel) *AccountLevel { s.BucketLevel = v return s } -// A container for the activity metrics. +// SetDetailedStatusCodesMetrics sets the DetailedStatusCodesMetrics field's value. +func (s *AccountLevel) SetDetailedStatusCodesMetrics(v *DetailedStatusCodesMetrics) *AccountLevel { + s.DetailedStatusCodesMetrics = v + return s +} + +// The container element for Amazon S3 Storage Lens activity metrics. Activity +// metrics show details about how your storage is requested, such as requests +// (for example, All requests, Get requests, Put requests), bytes uploaded or +// downloaded, and errors. +// +// For more information about S3 Storage Lens, see Assessing your storage activity +// and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// in the Amazon S3 User Guide. type ActivityMetrics struct { _ struct{} `type:"structure"` - // A container for whether the activity metrics are enabled. + // A container that indicates whether activity metrics are enabled. IsEnabled *bool `type:"boolean"` } @@ -6237,6 +6283,89 @@ func (s *ActivityMetrics) SetIsEnabled(v bool) *ActivityMetrics { return s } +// The container element for Amazon S3 Storage Lens advanced cost-optimization +// metrics. Advanced cost-optimization metrics provide insights that you can +// use to manage and optimize your storage costs, for example, lifecycle rule +// counts for transitions, expirations, and incomplete multipart uploads. +// +// For more information about S3 Storage Lens, see Assessing your storage activity +// and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// in the Amazon S3 User Guide. +type AdvancedCostOptimizationMetrics struct { + _ struct{} `type:"structure"` + + // A container that indicates whether advanced cost-optimization metrics are + // enabled. + IsEnabled *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AdvancedCostOptimizationMetrics) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AdvancedCostOptimizationMetrics) GoString() string { + return s.String() +} + +// SetIsEnabled sets the IsEnabled field's value. +func (s *AdvancedCostOptimizationMetrics) SetIsEnabled(v bool) *AdvancedCostOptimizationMetrics { + s.IsEnabled = &v + return s +} + +// The container element for Amazon S3 Storage Lens advanced data-protection +// metrics. Advanced data-protection metrics provide insights that you can use +// to perform audits and protect your data, for example replication rule counts +// within and across Regions. +// +// For more information about S3 Storage Lens, see Assessing your storage activity +// and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// in the Amazon S3 User Guide. +type AdvancedDataProtectionMetrics struct { + _ struct{} `type:"structure"` + + // A container that indicates whether advanced data-protection metrics are enabled. + IsEnabled *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AdvancedDataProtectionMetrics) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AdvancedDataProtectionMetrics) GoString() string { + return s.String() +} + +// SetIsEnabled sets the IsEnabled field's value. +func (s *AdvancedDataProtectionMetrics) SetIsEnabled(v bool) *AdvancedDataProtectionMetrics { + s.IsEnabled = &v + return s +} + // Error details for the failed asynchronous operation. type AsyncErrorDetails struct { _ struct{} `type:"structure"` @@ -6529,14 +6658,30 @@ func (s *AwsLambdaTransformation) SetFunctionPayload(v string) *AwsLambdaTransfo return s } -// A container for the bucket-level configuration. +// A container for the bucket-level configuration for Amazon S3 Storage Lens. +// +// For more information about S3 Storage Lens, see Assessing your storage activity +// and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. type BucketLevel struct { _ struct{} `type:"structure"` - // A container for the bucket-level activity metrics for Amazon S3 Storage Lens + // A container for the bucket-level activity metrics for S3 Storage Lens. ActivityMetrics *ActivityMetrics `type:"structure"` - // A container for the bucket-level prefix-level metrics for S3 Storage Lens + // A container for bucket-level advanced cost-optimization metrics for S3 Storage + // Lens. + AdvancedCostOptimizationMetrics *AdvancedCostOptimizationMetrics `type:"structure"` + + // A container for bucket-level advanced data-protection metrics for S3 Storage + // Lens. + AdvancedDataProtectionMetrics *AdvancedDataProtectionMetrics `type:"structure"` + + // A container for bucket-level detailed status code metrics for S3 Storage + // Lens. + DetailedStatusCodesMetrics *DetailedStatusCodesMetrics `type:"structure"` + + // A container for the prefix-level metrics for S3 Storage Lens. PrefixLevel *PrefixLevel `type:"structure"` } @@ -6579,6 +6724,24 @@ func (s *BucketLevel) SetActivityMetrics(v *ActivityMetrics) *BucketLevel { return s } +// SetAdvancedCostOptimizationMetrics sets the AdvancedCostOptimizationMetrics field's value. +func (s *BucketLevel) SetAdvancedCostOptimizationMetrics(v *AdvancedCostOptimizationMetrics) *BucketLevel { + s.AdvancedCostOptimizationMetrics = v + return s +} + +// SetAdvancedDataProtectionMetrics sets the AdvancedDataProtectionMetrics field's value. +func (s *BucketLevel) SetAdvancedDataProtectionMetrics(v *AdvancedDataProtectionMetrics) *BucketLevel { + s.AdvancedDataProtectionMetrics = v + return s +} + +// SetDetailedStatusCodesMetrics sets the DetailedStatusCodesMetrics field's value. +func (s *BucketLevel) SetDetailedStatusCodesMetrics(v *DetailedStatusCodesMetrics) *BucketLevel { + s.DetailedStatusCodesMetrics = v + return s +} + // SetPrefixLevel sets the PrefixLevel field's value. func (s *BucketLevel) SetPrefixLevel(v *PrefixLevel) *BucketLevel { s.PrefixLevel = v @@ -7575,7 +7738,7 @@ type CreateMultiRegionAccessPointInput_ struct { // see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. // - // This is not supported for Amazon S3 on Outposts. + // This data type is not supported for Amazon S3 on Outposts. PublicAccessBlock *PublicAccessBlockConfiguration `type:"structure"` // The buckets in different Regions that are associated with the Multi-Region @@ -9483,6 +9646,46 @@ func (s *DescribeMultiRegionAccessPointOperationOutput) SetAsyncOperation(v *Asy return s } +// The container element for Amazon S3 Storage Lens detailed status code metrics. +// Detailed status code metrics generate metrics for HTTP status codes, such +// as 200 OK, 403 Forbidden, 503 Service Unavailable and others. +// +// For more information about S3 Storage Lens, see Assessing your storage activity +// and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, +// see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// in the Amazon S3 User Guide. +type DetailedStatusCodesMetrics struct { + _ struct{} `type:"structure"` + + // A container that indicates whether detailed status code metrics are enabled. + IsEnabled *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DetailedStatusCodesMetrics) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DetailedStatusCodesMetrics) GoString() string { + return s.String() +} + +// SetIsEnabled sets the IsEnabled field's value. +func (s *DetailedStatusCodesMetrics) SetIsEnabled(v bool) *DetailedStatusCodesMetrics { + s.IsEnabled = &v + return s +} + // The last established access control policy for a Multi-Region Access Point. // // When you update the policy, the update is first listed as the proposed policy. @@ -10007,7 +10210,7 @@ type GetAccessPointOutput struct { // see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. // - // This is not supported for Amazon S3 on Outposts. + // This data type is not supported for Amazon S3 on Outposts. PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `type:"structure"` // Contains the virtual private cloud (VPC) configuration for the specified @@ -12810,8 +13013,8 @@ type JobOperation struct { // object in the manifest. S3InitiateRestoreObject *S3InitiateRestoreObjectOperation `type:"structure"` - // Directs the specified job to run a PUT Object acl call on every object in - // the manifest. + // Directs the specified job to run a PutObjectAcl call on every object in the + // manifest. S3PutObjectAcl *S3SetObjectAclOperation `type:"structure"` // Directs the specified job to run a PUT Copy object call on every object in @@ -13517,6 +13720,7 @@ type LifecycleRuleFilter struct { // related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). Prefix *string `type:"string"` + // A container for a key-value name pair. Tag *S3Tag `type:"structure"` } @@ -14581,7 +14785,7 @@ type MultiRegionAccessPointReport struct { // see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. // - // This is not supported for Amazon S3 on Outposts. + // This data type is not supported for Amazon S3 on Outposts. PublicAccessBlock *PublicAccessBlockConfiguration `type:"structure"` // A collection of the Regions and buckets associated with the Multi-Region @@ -15218,7 +15422,7 @@ func (s *ProposedMultiRegionAccessPointPolicy) SetPolicy(v string) *ProposedMult // see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. // -// This is not supported for Amazon S3 on Outposts. +// This data type is not supported for Amazon S3 on Outposts. type PublicAccessBlockConfiguration struct { _ struct{} `type:"structure"` @@ -15226,8 +15430,7 @@ type PublicAccessBlockConfiguration struct { // for buckets in this account. Setting this element to TRUE causes the following // behavior: // - // * PUT Bucket acl and PUT Object acl calls fail if the specified ACL is - // public. + // * PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public. // // * PUT Object calls fail if the request includes a public ACL. // @@ -15235,7 +15438,7 @@ type PublicAccessBlockConfiguration struct { // // Enabling this setting doesn't affect existing policies or ACLs. // - // This is not supported for Amazon S3 on Outposts. + // This property is not supported for Amazon S3 on Outposts. BlockPublicAcls *bool `locationName:"BlockPublicAcls" type:"boolean"` // Specifies whether Amazon S3 should block public bucket policies for buckets @@ -15244,7 +15447,7 @@ type PublicAccessBlockConfiguration struct { // // Enabling this setting doesn't affect existing bucket policies. // - // This is not supported for Amazon S3 on Outposts. + // This property is not supported for Amazon S3 on Outposts. BlockPublicPolicy *bool `locationName:"BlockPublicPolicy" type:"boolean"` // Specifies whether Amazon S3 should ignore public ACLs for buckets in this @@ -15254,7 +15457,7 @@ type PublicAccessBlockConfiguration struct { // Enabling this setting doesn't affect the persistence of any existing ACLs // and doesn't prevent new public ACLs from being set. // - // This is not supported for Amazon S3 on Outposts. + // This property is not supported for Amazon S3 on Outposts. IgnorePublicAcls *bool `locationName:"IgnorePublicAcls" type:"boolean"` // Specifies whether Amazon S3 should restrict public bucket policies for buckets @@ -15266,7 +15469,7 @@ type PublicAccessBlockConfiguration struct { // that public and cross-account access within any public bucket policy, including // non-public delegation to specific accounts, is blocked. // - // This is not supported for Amazon S3 on Outposts. + // This property is not supported for Amazon S3 on Outposts. RestrictPublicBuckets *bool `locationName:"RestrictPublicBuckets" type:"boolean"` } @@ -17450,8 +17653,8 @@ type S3CopyObjectOperation struct { TargetKeyPrefix *string `min:"1" type:"string"` // Specifies the destination bucket ARN for the batch copy operation. For example, - // to copy objects to a bucket named "destinationBucket", set the TargetResource - // to "arn:aws:s3:::destinationBucket". + // to copy objects to a bucket named destinationBucket, set the TargetResource + // property to arn:aws:s3:::destinationBucket. TargetResource *string `min:"1" type:"string"` UnModifiedSinceConstraint *time.Time `type:"timestamp"` @@ -18387,9 +18590,9 @@ func (s *S3Retention) SetRetainUntilDate(v time.Time) *S3Retention { } // Contains the configuration parameters for a Set Object ACL operation. S3 -// Batch Operations passes every object to the underlying PUT Object acl API. -// For more information about the parameters for this operation, see PUT Object -// acl (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html). +// Batch Operations passes every object to the underlying PutObjectAcl API. +// For more information about the parameters for this operation, see PutObjectAcl +// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html). type S3SetObjectAclOperation struct { _ struct{} `type:"structure"` @@ -18610,12 +18813,17 @@ func (s *S3SetObjectTaggingOperation) SetTagSet(v []*S3Tag) *S3SetObjectTaggingO return s } +// A container for a key-value name pair. type S3Tag struct { _ struct{} `type:"structure"` + // Key of the tag + // // Key is a required field Key *string `min:"1" type:"string" required:"true"` + // Value of the tag + // // Value is a required field Value *string `type:"string" required:"true"` } diff --git a/service/secretsmanager/api.go b/service/secretsmanager/api.go index c84e8c6d3c5..6bc8063f1a7 100644 --- a/service/secretsmanager/api.go +++ b/service/secretsmanager/api.go @@ -1982,6 +1982,11 @@ func (c *SecretsManager) RotateSecretRequest(input *RotateSecretInput) (req *req // assumes that a previous rotation request is still in progress and returns // an error. // +// When rotation is unsuccessful, the AWSPENDING staging label might be attached +// to an empty secret version. For more information, see Troubleshoot rotation +// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html) +// in the Secrets Manager User Guide. +// // Secrets Manager generates a CloudTrail log entry when you call this action. // Do not include sensitive information in request parameters because it might // be logged. For more information, see Logging Secrets Manager events with @@ -3432,8 +3437,8 @@ type DeleteSecretInput struct { // Use this parameter with caution. This parameter causes the operation to skip // the normal recovery window before the permanent deletion that Secrets Manager // would normally impose with the RecoveryWindowInDays parameter. If you delete - // a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity - // to recover the secret. You lose the secret permanently. + // a secret with the ForceDeleteWithoutRecovery parameter, then you have no + // opportunity to recover the secret. You lose the secret permanently. ForceDeleteWithoutRecovery *bool `type:"boolean"` // The number of days from 7 to 30 that Secrets Manager waits before permanently @@ -4923,7 +4928,7 @@ type ListSecretsInput struct { // again with this value. NextToken *string `min:"1" type:"string"` - // Lists secrets in the requested order. + // Secrets are listed by CreatedDate. SortOrder *string `type:"string" enum:"SortOrderType"` } @@ -6325,34 +6330,42 @@ type RotationRulesType struct { // In DescribeSecret and ListSecrets, this value is calculated from the rotation // schedule after every successful rotation. In RotateSecret, you can set the // rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, - // but not both. + // but not both. To set a rotation schedule in hours, use ScheduleExpression. AutomaticallyAfterDays *int64 `min:"1" type:"long"` // The length of the rotation window in hours, for example 3h for a three hour // window. Secrets Manager rotates your secret at any time during this window. - // The window must not go into the next UTC day. If you don't specify this value, - // the window automatically ends at the end of the UTC day. The window begins - // according to the ScheduleExpression. For more information, including examples, - // see Schedule expressions in Secrets Manager rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html). + // The window must not extend into the next rotation window or the next UTC + // day. The window starts according to the ScheduleExpression. If you don't + // specify a Duration, for a ScheduleExpression in hours, the window automatically + // closes after one hour. For a ScheduleExpression in days, the window automatically + // closes at the end of the UTC day. For more information, including examples, + // see Schedule expressions in Secrets Manager rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) + // in the Secrets Manager Users Guide. Duration *string `min:"2" type:"string"` // A cron() or rate() expression that defines the schedule for rotating your - // secret. Secrets Manager rotation schedules use UTC time zone. - // - // Secrets Manager rate() expressions represent the interval in days that you - // want to rotate your secret, for example rate(10 days). If you use a rate() - // expression, the rotation window opens at midnight, and Secrets Manager rotates - // your secret any time that day after midnight. You can set a Duration to shorten - // the rotation window. - // - // You can use a cron() expression to create rotation schedules that are more + // secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager + // rotates your secret any time during a rotation window. + // + // Secrets Manager rate() expressions represent the interval in hours or days + // that you want to rotate your secret, for example rate(12 hours) or rate(10 + // days). You can rotate a secret as often as every four hours. If you use a + // rate() expression, the rotation window starts at midnight. For a rate in + // hours, the default rotation window closes after one hour. For a rate in days, + // the default rotation window closes at the end of the day. You can set the + // Duration to change the rotation window. The rotation window must not extend + // into the next UTC day or into the next rotation window. + // + // You can use a cron() expression to create a rotation schedule that is more // detailed than a rotation interval. For more information, including examples, - // see Schedule expressions in Secrets Manager rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html). - // If you use a cron() expression, Secrets Manager rotates your secret any time - // during that day after the window opens. For example, cron(0 8 1 * ? *) represents - // a rotation window that occurs on the first day of every month beginning at - // 8:00 AM UTC. Secrets Manager rotates the secret any time that day after 8:00 - // AM. You can set a Duration to shorten the rotation window. + // see Schedule expressions in Secrets Manager rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) + // in the Secrets Manager Users Guide. For a cron expression that represents + // a schedule in hours, the default rotation window closes after one hour. For + // a cron expression that represents a schedule in days, the default rotation + // window closes at the end of the day. You can set the Duration to change the + // rotation window. The rotation window must not extend into the next UTC day + // or into the next rotation window. ScheduleExpression *string `min:"1" type:"string"` } diff --git a/service/securityhub/api.go b/service/securityhub/api.go index c25fe2eb06c..845c782e804 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -24329,10 +24329,14 @@ func (s *AwsLambdaFunctionDeadLetterConfig) SetTargetArn(v string) *AwsLambdaFun return s } -// Details about a function's configuration. +// Details about an Lambda function's configuration. type AwsLambdaFunctionDetails struct { _ struct{} `type:"structure"` + // The instruction set architecture that the function uses. Valid values are + // x86_64 or arm64. + Architectures []*string `type:"list"` + // An AwsLambdaFunctionCode object. Code *AwsLambdaFunctionCode `type:"structure"` @@ -24372,6 +24376,10 @@ type AwsLambdaFunctionDetails struct { // The memory that is allocated to the function. MemorySize *int64 `type:"integer"` + // The type of deployment package that's used to deploy the function code to + // Lambda. Set to Image for a container image and Zip for a .zip file archive. + PackageType *string `type:"string"` + // The latest updated revision of the function or alias. RevisionId *string `type:"string"` @@ -24412,6 +24420,12 @@ func (s AwsLambdaFunctionDetails) GoString() string { return s.String() } +// SetArchitectures sets the Architectures field's value. +func (s *AwsLambdaFunctionDetails) SetArchitectures(v []*string) *AwsLambdaFunctionDetails { + s.Architectures = v + return s +} + // SetCode sets the Code field's value. func (s *AwsLambdaFunctionDetails) SetCode(v *AwsLambdaFunctionCode) *AwsLambdaFunctionDetails { s.Code = v @@ -24478,6 +24492,12 @@ func (s *AwsLambdaFunctionDetails) SetMemorySize(v int64) *AwsLambdaFunctionDeta return s } +// SetPackageType sets the PackageType field's value. +func (s *AwsLambdaFunctionDetails) SetPackageType(v string) *AwsLambdaFunctionDetails { + s.PackageType = &v + return s +} + // SetRevisionId sets the RevisionId field's value. func (s *AwsLambdaFunctionDetails) SetRevisionId(v string) *AwsLambdaFunctionDetails { s.RevisionId = &v @@ -45355,6 +45375,12 @@ type SoftwarePackage struct { // the software package. Remediation *string `type:"string"` + // The Amazon Resource Name (ARN) of the source layer. + SourceLayerArn *string `type:"string"` + + // The source layer hash of the vulnerable package. + SourceLayerHash *string `type:"string"` + // The version of the software package. Version *string `type:"string"` } @@ -45425,6 +45451,18 @@ func (s *SoftwarePackage) SetRemediation(v string) *SoftwarePackage { return s } +// SetSourceLayerArn sets the SourceLayerArn field's value. +func (s *SoftwarePackage) SetSourceLayerArn(v string) *SoftwarePackage { + s.SourceLayerArn = &v + return s +} + +// SetSourceLayerHash sets the SourceLayerHash field's value. +func (s *SoftwarePackage) SetSourceLayerHash(v string) *SoftwarePackage { + s.SourceLayerHash = &v + return s +} + // SetVersion sets the Version field's value. func (s *SoftwarePackage) SetVersion(v string) *SoftwarePackage { s.Version = &v diff --git a/service/sts/api.go b/service/sts/api.go index 2b7e675ab86..c0706bec93d 100644 --- a/service/sts/api.go +++ b/service/sts/api.go @@ -74,16 +74,16 @@ func (c *STS) AssumeRoleRequest(input *AssumeRoleInput) (req *request.Request, o // // (Optional) You can pass inline or managed session policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an -// inline session policy. You can also specify up to 10 managed policies to -// use as managed session policies. The plaintext that you use for both inline -// and managed session policies can't exceed 2,048 characters. Passing policies -// to this operation returns new temporary credentials. The resulting session's -// permissions are the intersection of the role's identity-based policy and -// the session policies. You can use the role's temporary credentials in subsequent -// Amazon Web Services API calls to access resources in the account that owns -// the role. You cannot use session policies to grant more permissions than -// those allowed by the identity-based policy of the role that is being assumed. -// For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// inline session policy. You can also specify up to 10 managed policy Amazon +// Resource Names (ARNs) to use as managed session policies. The plaintext that +// you use for both inline and managed session policies can't exceed 2,048 characters. +// Passing policies to this operation returns new temporary credentials. The +// resulting session's permissions are the intersection of the role's identity-based +// policy and the session policies. You can use the role's temporary credentials +// in subsequent Amazon Web Services API calls to access resources in the account +// that owns the role. You cannot use session policies to grant more permissions +// than those allowed by the identity-based policy of the role that is being +// assumed. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // When you create a role, you create two policies: A role trust policy that @@ -307,16 +307,16 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re // // (Optional) You can pass inline or managed session policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an -// inline session policy. You can also specify up to 10 managed policies to -// use as managed session policies. The plaintext that you use for both inline -// and managed session policies can't exceed 2,048 characters. Passing policies -// to this operation returns new temporary credentials. The resulting session's -// permissions are the intersection of the role's identity-based policy and -// the session policies. You can use the role's temporary credentials in subsequent -// Amazon Web Services API calls to access resources in the account that owns -// the role. You cannot use session policies to grant more permissions than -// those allowed by the identity-based policy of the role that is being assumed. -// For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// inline session policy. You can also specify up to 10 managed policy Amazon +// Resource Names (ARNs) to use as managed session policies. The plaintext that +// you use for both inline and managed session policies can't exceed 2,048 characters. +// Passing policies to this operation returns new temporary credentials. The +// resulting session's permissions are the intersection of the role's identity-based +// policy and the session policies. You can use the role's temporary credentials +// in subsequent Amazon Web Services API calls to access resources in the account +// that owns the role. You cannot use session policies to grant more permissions +// than those allowed by the identity-based policy of the role that is being +// assumed. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // Calling AssumeRoleWithSAML does not require the use of Amazon Web Services @@ -343,11 +343,12 @@ func (c *STS) AssumeRoleWithSAMLRequest(input *AssumeRoleWithSAMLInput) (req *re // and additional limits, see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // -// An Amazon Web Services conversion compresses the passed session policies -// and session tags into a packed binary format that has a separate limit. Your -// request can fail for this limit even if your plaintext meets the other requirements. -// The PackedPolicySize response element indicates by percentage how close the -// policies and tags for your request are to the upper size limit. +// An Amazon Web Services conversion compresses the passed inline session policy, +// managed policy ARNs, and session tags into a packed binary format that has +// a separate limit. Your request can fail for this limit even if your plaintext +// meets the other requirements. The PackedPolicySize response element indicates +// by percentage how close the policies and tags for your request are to the +// upper size limit. // // You can pass a session tag with the same key as a tag that is attached to // the role. When you do, session tags override the role's tags with the same @@ -563,16 +564,16 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI // // (Optional) You can pass inline or managed session policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an -// inline session policy. You can also specify up to 10 managed policies to -// use as managed session policies. The plaintext that you use for both inline -// and managed session policies can't exceed 2,048 characters. Passing policies -// to this operation returns new temporary credentials. The resulting session's -// permissions are the intersection of the role's identity-based policy and -// the session policies. You can use the role's temporary credentials in subsequent -// Amazon Web Services API calls to access resources in the account that owns -// the role. You cannot use session policies to grant more permissions than -// those allowed by the identity-based policy of the role that is being assumed. -// For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// inline session policy. You can also specify up to 10 managed policy Amazon +// Resource Names (ARNs) to use as managed session policies. The plaintext that +// you use for both inline and managed session policies can't exceed 2,048 characters. +// Passing policies to this operation returns new temporary credentials. The +// resulting session's permissions are the intersection of the role's identity-based +// policy and the session policies. You can use the role's temporary credentials +// in subsequent Amazon Web Services API calls to access resources in the account +// that owns the role. You cannot use session policies to grant more permissions +// than those allowed by the identity-based policy of the role that is being +// assumed. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // # Tags @@ -588,11 +589,12 @@ func (c *STS) AssumeRoleWithWebIdentityRequest(input *AssumeRoleWithWebIdentityI // and additional limits, see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // -// An Amazon Web Services conversion compresses the passed session policies -// and session tags into a packed binary format that has a separate limit. Your -// request can fail for this limit even if your plaintext meets the other requirements. -// The PackedPolicySize response element indicates by percentage how close the -// policies and tags for your request are to the upper size limit. +// An Amazon Web Services conversion compresses the passed inline session policy, +// managed policy ARNs, and session tags into a packed binary format that has +// a separate limit. Your request can fail for this limit even if your plaintext +// meets the other requirements. The PackedPolicySize response element indicates +// by percentage how close the policies and tags for your request are to the +// upper size limit. // // You can pass a session tag with the same key as a tag that is attached to // the role. When you do, the session tag overrides the role tag with the same @@ -1110,9 +1112,9 @@ func (c *STS) GetFederationTokenRequest(input *GetFederationTokenInput) (req *re // // You must pass an inline or managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an -// inline session policy. You can also specify up to 10 managed policies to -// use as managed session policies. The plaintext that you use for both inline -// and managed session policies can't exceed 2,048 characters. +// inline session policy. You can also specify up to 10 managed policy Amazon +// Resource Names (ARNs) to use as managed session policies. The plaintext that +// you use for both inline and managed session policies can't exceed 2,048 characters. // // Though the session policy parameters are optional, if you do not pass a policy, // then the resulting federated user session has no permissions. When you pass @@ -1424,11 +1426,12 @@ type AssumeRoleInput struct { // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage // return (\u000D) characters. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. Policy *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of the IAM managed policies that you want @@ -1441,11 +1444,12 @@ type AssumeRoleInput struct { // Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the Amazon Web Services General Reference. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. // // Passing policies to this operation returns new temporary credentials. The // resulting session's permissions are the intersection of the role's identity-based @@ -1520,11 +1524,12 @@ type AssumeRoleInput struct { // Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. // // You can pass a session tag with the same key as a tag that is already attached // to the role. When you do, session tags override a role tag with the same @@ -1843,11 +1848,12 @@ type AssumeRoleWithSAMLInput struct { // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage // return (\u000D) characters. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. Policy *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of the IAM managed policies that you want @@ -1860,11 +1866,12 @@ type AssumeRoleWithSAMLInput struct { // Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the Amazon Web Services General Reference. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. // // Passing policies to this operation returns new temporary credentials. The // resulting session's permissions are the intersection of the role's identity-based @@ -2190,11 +2197,12 @@ type AssumeRoleWithWebIdentityInput struct { // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage // return (\u000D) characters. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. Policy *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of the IAM managed policies that you want @@ -2207,11 +2215,12 @@ type AssumeRoleWithWebIdentityInput struct { // Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the Amazon Web Services General Reference. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. // // Passing policies to this operation returns new temporary credentials. The // resulting session's permissions are the intersection of the role's identity-based @@ -2934,8 +2943,8 @@ type GetFederationTokenInput struct { // // You must pass an inline or managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an - // inline session policy. You can also specify up to 10 managed policies to - // use as managed session policies. + // inline session policy. You can also specify up to 10 managed policy Amazon + // Resource Names (ARNs) to use as managed session policies. // // This parameter is optional. However, if you do not pass any session policies, // then the resulting federated user session has no permissions. @@ -2960,11 +2969,12 @@ type GetFederationTokenInput struct { // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage // return (\u000D) characters. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. Policy *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of the IAM managed policies that you want @@ -2973,11 +2983,12 @@ type GetFederationTokenInput struct { // // You must pass an inline or managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an - // inline session policy. You can also specify up to 10 managed policies to - // use as managed session policies. The plaintext that you use for both inline - // and managed session policies can't exceed 2,048 characters. You can provide - // up to 10 managed policy ARNs. For more information about ARNs, see Amazon - // Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // inline session policy. You can also specify up to 10 managed policy Amazon + // Resource Names (ARNs) to use as managed session policies. The plaintext that + // you use for both inline and managed session policies can't exceed 2,048 characters. + // You can provide up to 10 managed policy ARNs. For more information about + // ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces + // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // in the Amazon Web Services General Reference. // // This parameter is optional. However, if you do not pass any session policies, @@ -2997,11 +3008,12 @@ type GetFederationTokenInput struct { // by the policy. These permissions are granted in addition to the permissions // that are granted by the session policies. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. PolicyArns []*PolicyDescriptorType `type:"list"` // A list of session tags. Each session tag consists of a key name and an associated @@ -3015,11 +3027,12 @@ type GetFederationTokenInput struct { // Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // - // An Amazon Web Services conversion compresses the passed session policies - // and session tags into a packed binary format that has a separate limit. Your - // request can fail for this limit even if your plaintext meets the other requirements. - // The PackedPolicySize response element indicates by percentage how close the - // policies and tags for your request are to the upper size limit. + // An Amazon Web Services conversion compresses the passed inline session policy, + // managed policy ARNs, and session tags into a packed binary format that has + // a separate limit. Your request can fail for this limit even if your plaintext + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the + // upper size limit. // // You can pass a session tag with the same key as a tag that is already attached // to the user you are federating. When you do, session tags override a user diff --git a/service/textract/api.go b/service/textract/api.go index bc5cd6825e6..ac5366cdd2f 100644 --- a/service/textract/api.go +++ b/service/textract/api.go @@ -72,6 +72,11 @@ func (c *Textract) AnalyzeDocumentRequest(input *AnalyzeDocumentInput) (req *req // returned (including text that doesn't have a relationship with the value // of FeatureTypes). // +// - Signatures. A SIGNATURE Block object contains the location information +// of a signature in a document. If used in conjunction with forms or tables, +// a signature can be given a Key-Value pairing or be detected in the cell +// of a table. +// // - Query. A QUERY Block object contains the query text, alias and link // to the associated Query results block object. // @@ -1484,10 +1489,12 @@ type AnalyzeDocumentInput struct { // A list of the types of analysis to perform. Add TABLES to the list to return // information about the tables that are detected in the input document. Add - // FORMS to return detected form data. To perform both types of analysis, add - // TABLES and FORMS to FeatureTypes. All lines and words detected in the document - // are included in the response (including text that isn't related to the value - // of FeatureTypes). + // FORMS to return detected form data. Add SIGNATURES to return the locations + // of detected signatures. To perform both forms and table analysis, add TABLES + // and FORMS to FeatureTypes. To detect signatures within form data and table + // data, add SIGNATURES to either TABLES or FORMS. All lines and words detected + // in the document are included in the response (including text that isn't related + // to the value of FeatureTypes). // // FeatureTypes is a required field FeatureTypes []*string `type:"list" required:"true" enum:"FeatureType"` @@ -2024,6 +2031,10 @@ type Block struct { // button) or a check box that's detected on a document page. Use the value // of SelectionStatus to determine the status of the selection element. // + // * SIGNATURE - The location and confidene score of a signature detected + // on a document page. Can be returned as part of a Key-Value pair or a detected + // cell. + // // * QUERY - A question asked during the call of AnalyzeDocument. Contains // an alias and an ID that attaches it to its answer. // @@ -5697,6 +5708,9 @@ const ( // BlockTypeQueryResult is a BlockType enum value BlockTypeQueryResult = "QUERY_RESULT" + + // BlockTypeSignature is a BlockType enum value + BlockTypeSignature = "SIGNATURE" ) // BlockType_Values returns all elements of the BlockType enum @@ -5713,6 +5727,7 @@ func BlockType_Values() []string { BlockTypeTitle, BlockTypeQuery, BlockTypeQueryResult, + BlockTypeSignature, } } @@ -5761,6 +5776,9 @@ const ( // FeatureTypeQueries is a FeatureType enum value FeatureTypeQueries = "QUERIES" + + // FeatureTypeSignatures is a FeatureType enum value + FeatureTypeSignatures = "SIGNATURES" ) // FeatureType_Values returns all elements of the FeatureType enum @@ -5769,6 +5787,7 @@ func FeatureType_Values() []string { FeatureTypeTables, FeatureTypeForms, FeatureTypeQueries, + FeatureTypeSignatures, } } diff --git a/service/workspaces/api.go b/service/workspaces/api.go index a9047f59195..b84a0fca95c 100644 --- a/service/workspaces/api.go +++ b/service/workspaces/api.go @@ -707,6 +707,97 @@ func (c *WorkSpaces) CreateIpGroupWithContext(ctx aws.Context, input *CreateIpGr return out, req.Send() } +const opCreateStandbyWorkspaces = "CreateStandbyWorkspaces" + +// CreateStandbyWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the CreateStandbyWorkspaces operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateStandbyWorkspaces for more information on using the CreateStandbyWorkspaces +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateStandbyWorkspacesRequest method. +// req, resp := client.CreateStandbyWorkspacesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateStandbyWorkspaces +func (c *WorkSpaces) CreateStandbyWorkspacesRequest(input *CreateStandbyWorkspacesInput) (req *request.Request, output *CreateStandbyWorkspacesOutput) { + op := &request.Operation{ + Name: opCreateStandbyWorkspaces, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateStandbyWorkspacesInput{} + } + + output = &CreateStandbyWorkspacesOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateStandbyWorkspaces API operation for Amazon WorkSpaces. +// +// Creates a Standby WorkSpace in a secondary region. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon WorkSpaces's +// API operation CreateStandbyWorkspaces for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - ResourceLimitExceededException +// Your resource limits have been exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateStandbyWorkspaces +func (c *WorkSpaces) CreateStandbyWorkspaces(input *CreateStandbyWorkspacesInput) (*CreateStandbyWorkspacesOutput, error) { + req, out := c.CreateStandbyWorkspacesRequest(input) + return out, req.Send() +} + +// CreateStandbyWorkspacesWithContext is the same as CreateStandbyWorkspaces with the addition of +// the ability to pass a context and additional request options. +// +// See CreateStandbyWorkspaces for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *WorkSpaces) CreateStandbyWorkspacesWithContext(ctx aws.Context, input *CreateStandbyWorkspacesInput, opts ...request.Option) (*CreateStandbyWorkspacesOutput, error) { + req, out := c.CreateStandbyWorkspacesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateTags = "CreateTags" // CreateTagsRequest generates a "aws/request.Request" representing the @@ -4813,6 +4904,9 @@ func (c *WorkSpaces) ModifyWorkspaceStateRequest(input *ModifyWorkspaceStateInpu // - ResourceNotFoundException // The resource could not be found. // +// - OperationNotSupportedException +// This operation is not supported. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState func (c *WorkSpaces) ModifyWorkspaceState(input *ModifyWorkspaceStateInput) (*ModifyWorkspaceStateOutput, error) { req, out := c.ModifyWorkspaceStateRequest(input) @@ -4890,6 +4984,11 @@ func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req // // See the AWS API reference guide for Amazon WorkSpaces's // API operation RebootWorkspaces for usage and error information. +// +// Returned Error Types: +// - OperationNotSupportedException +// This operation is not supported. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error) { req, out := c.RebootWorkspacesRequest(input) @@ -4972,6 +5071,11 @@ func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (re // // See the AWS API reference guide for Amazon WorkSpaces's // API operation RebuildWorkspaces for usage and error information. +// +// Returned Error Types: +// - OperationNotSupportedException +// This operation is not supported. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error) { req, out := c.RebuildWorkspacesRequest(input) @@ -5178,6 +5282,9 @@ func (c *WorkSpaces) RestoreWorkspaceRequest(input *RestoreWorkspaceInput) (req // - AccessDeniedException // The user is not authorized to access a resource. // +// - OperationNotSupportedException +// This operation is not supported. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace func (c *WorkSpaces) RestoreWorkspace(input *RestoreWorkspaceInput) (*RestoreWorkspaceOutput, error) { req, out := c.RestoreWorkspaceRequest(input) @@ -5905,6 +6012,9 @@ func (c *WorkSpaces) UpdateWorkspaceBundleRequest(input *UpdateWorkspaceBundleIn // - ResourceUnavailableException // The specified resource is not available. // +// - OperationNotSupportedException +// This operation is not supported. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle func (c *WorkSpaces) UpdateWorkspaceBundle(input *UpdateWorkspaceBundleInput) (*UpdateWorkspaceBundleOutput, error) { req, out := c.UpdateWorkspaceBundleRequest(input) @@ -7362,6 +7472,119 @@ func (s *CreateIpGroupOutput) SetGroupId(v string) *CreateIpGroupOutput { return s } +type CreateStandbyWorkspacesInput struct { + _ struct{} `type:"structure"` + + // The Region of the primary WorkSpace. + // + // PrimaryRegion is a required field + PrimaryRegion *string `min:"1" type:"string" required:"true"` + + // Information about the Standby WorkSpace to be created. + // + // StandbyWorkspaces is a required field + StandbyWorkspaces []*StandbyWorkspace `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateStandbyWorkspacesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateStandbyWorkspacesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateStandbyWorkspacesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateStandbyWorkspacesInput"} + if s.PrimaryRegion == nil { + invalidParams.Add(request.NewErrParamRequired("PrimaryRegion")) + } + if s.PrimaryRegion != nil && len(*s.PrimaryRegion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PrimaryRegion", 1)) + } + if s.StandbyWorkspaces == nil { + invalidParams.Add(request.NewErrParamRequired("StandbyWorkspaces")) + } + if s.StandbyWorkspaces != nil { + for i, v := range s.StandbyWorkspaces { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "StandbyWorkspaces", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPrimaryRegion sets the PrimaryRegion field's value. +func (s *CreateStandbyWorkspacesInput) SetPrimaryRegion(v string) *CreateStandbyWorkspacesInput { + s.PrimaryRegion = &v + return s +} + +// SetStandbyWorkspaces sets the StandbyWorkspaces field's value. +func (s *CreateStandbyWorkspacesInput) SetStandbyWorkspaces(v []*StandbyWorkspace) *CreateStandbyWorkspacesInput { + s.StandbyWorkspaces = v + return s +} + +type CreateStandbyWorkspacesOutput struct { + _ struct{} `type:"structure"` + + // Information about the Standby WorkSpace that could not be created. + FailedStandbyRequests []*FailedCreateStandbyWorkspacesRequest `type:"list"` + + // Information about the Standby WorkSpace that was created. + PendingStandbyRequests []*PendingCreateStandbyWorkspacesRequest `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateStandbyWorkspacesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateStandbyWorkspacesOutput) GoString() string { + return s.String() +} + +// SetFailedStandbyRequests sets the FailedStandbyRequests field's value. +func (s *CreateStandbyWorkspacesOutput) SetFailedStandbyRequests(v []*FailedCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput { + s.FailedStandbyRequests = v + return s +} + +// SetPendingStandbyRequests sets the PendingStandbyRequests field's value. +func (s *CreateStandbyWorkspacesOutput) SetPendingStandbyRequests(v []*PendingCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput { + s.PendingStandbyRequests = v + return s +} + type CreateTagsInput struct { _ struct{} `type:"structure"` @@ -10835,6 +11058,57 @@ func (s DisassociateIpGroupsOutput) GoString() string { return s.String() } +// Describes the Standby WorkSpace that could not be created. +type FailedCreateStandbyWorkspacesRequest struct { + _ struct{} `type:"structure"` + + // The error code that is returned if the Standby WorkSpace could not be created. + ErrorCode *string `type:"string"` + + // The text of the error message that is returned if the Standby WorkSpace could + // not be created. + ErrorMessage *string `type:"string"` + + // Information about the Standby WorkSpace that could not be created. + StandbyWorkspaceRequest *StandbyWorkspace `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailedCreateStandbyWorkspacesRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailedCreateStandbyWorkspacesRequest) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *FailedCreateStandbyWorkspacesRequest) SetErrorCode(v string) *FailedCreateStandbyWorkspacesRequest { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *FailedCreateStandbyWorkspacesRequest) SetErrorMessage(v string) *FailedCreateStandbyWorkspacesRequest { + s.ErrorMessage = &v + return s +} + +// SetStandbyWorkspaceRequest sets the StandbyWorkspaceRequest field's value. +func (s *FailedCreateStandbyWorkspacesRequest) SetStandbyWorkspaceRequest(v *StandbyWorkspace) *FailedCreateStandbyWorkspacesRequest { + s.StandbyWorkspaceRequest = v + return s +} + // Describes a WorkSpace that cannot be created. type FailedCreateWorkspaceRequest struct { _ struct{} `type:"structure"` @@ -13053,6 +13327,70 @@ func (s *OperationNotSupportedException) RequestID() string { return s.RespMetadata.RequestID } +// Information about the Standby WorkSpace. +type PendingCreateStandbyWorkspacesRequest struct { + _ struct{} `type:"structure"` + + // The identifier of the directory for the Standby WorkSpace. + DirectoryId *string `min:"10" type:"string"` + + // The operational state of the Standby WorkSpace. + State *string `type:"string" enum:"WorkspaceState"` + + // Describes the Standby WorkSpace that was created. + // + // Because this operation is asynchronous, the identifier returned is not immediately + // available for use with other operations. For example, if you call DescribeWorkspaces + // (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) + // before the WorkSpace is created, the information returned can be incomplete. + UserName *string `min:"1" type:"string"` + + // The identifier of the Standby WorkSpace. + WorkspaceId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PendingCreateStandbyWorkspacesRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PendingCreateStandbyWorkspacesRequest) GoString() string { + return s.String() +} + +// SetDirectoryId sets the DirectoryId field's value. +func (s *PendingCreateStandbyWorkspacesRequest) SetDirectoryId(v string) *PendingCreateStandbyWorkspacesRequest { + s.DirectoryId = &v + return s +} + +// SetState sets the State field's value. +func (s *PendingCreateStandbyWorkspacesRequest) SetState(v string) *PendingCreateStandbyWorkspacesRequest { + s.State = &v + return s +} + +// SetUserName sets the UserName field's value. +func (s *PendingCreateStandbyWorkspacesRequest) SetUserName(v string) *PendingCreateStandbyWorkspacesRequest { + s.UserName = &v + return s +} + +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *PendingCreateStandbyWorkspacesRequest) SetWorkspaceId(v string) *PendingCreateStandbyWorkspacesRequest { + s.WorkspaceId = &v + return s +} + // Describes the information used to reboot a WorkSpace. type RebootRequest struct { _ struct{} `type:"structure"` @@ -13474,6 +13812,66 @@ func (s RegisterWorkspaceDirectoryOutput) GoString() string { return s.String() } +// Describes the related WorkSpace. The related WorkSpace could be a Standby +// WorkSpace or Primary WorkSpace related to the specified WorkSpace. +type RelatedWorkspaceProperties struct { + _ struct{} `type:"structure"` + + // The Region of the related WorkSpace. + Region *string `min:"1" type:"string"` + + // Indicates the state of the WorkSpace. + State *string `type:"string" enum:"WorkspaceState"` + + // Indicates the type of WorkSpace. + Type *string `type:"string" enum:"StandbyWorkspaceRelationshipType"` + + // The identifier of the related WorkSpace. + WorkspaceId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RelatedWorkspaceProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RelatedWorkspaceProperties) GoString() string { + return s.String() +} + +// SetRegion sets the Region field's value. +func (s *RelatedWorkspaceProperties) SetRegion(v string) *RelatedWorkspaceProperties { + s.Region = &v + return s +} + +// SetState sets the State field's value. +func (s *RelatedWorkspaceProperties) SetState(v string) *RelatedWorkspaceProperties { + s.State = &v + return s +} + +// SetType sets the Type field's value. +func (s *RelatedWorkspaceProperties) SetType(v string) *RelatedWorkspaceProperties { + s.Type = &v + return s +} + +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *RelatedWorkspaceProperties) SetWorkspaceId(v string) *RelatedWorkspaceProperties { + s.WorkspaceId = &v + return s +} + // The specified resource already exists. type ResourceAlreadyExistsException struct { _ struct{} `type:"structure"` @@ -14257,6 +14655,98 @@ func (s *Snapshot) SetSnapshotTime(v time.Time) *Snapshot { return s } +// Describes a Standby WorkSpace. +type StandbyWorkspace struct { + _ struct{} `type:"structure"` + + // The identifier of the directory for the Standby WorkSpace. + // + // DirectoryId is a required field + DirectoryId *string `min:"10" type:"string" required:"true"` + + // The identifier of the Standby WorkSpace. + // + // PrimaryWorkspaceId is a required field + PrimaryWorkspaceId *string `type:"string" required:"true"` + + // The tags associated with the Standby WorkSpace. + Tags []*Tag `type:"list"` + + // The volume encryption key of the Standby WorkSpace. + VolumeEncryptionKey *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StandbyWorkspace) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StandbyWorkspace) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StandbyWorkspace) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StandbyWorkspace"} + if s.DirectoryId == nil { + invalidParams.Add(request.NewErrParamRequired("DirectoryId")) + } + if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) + } + if s.PrimaryWorkspaceId == nil { + invalidParams.Add(request.NewErrParamRequired("PrimaryWorkspaceId")) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDirectoryId sets the DirectoryId field's value. +func (s *StandbyWorkspace) SetDirectoryId(v string) *StandbyWorkspace { + s.DirectoryId = &v + return s +} + +// SetPrimaryWorkspaceId sets the PrimaryWorkspaceId field's value. +func (s *StandbyWorkspace) SetPrimaryWorkspaceId(v string) *StandbyWorkspace { + s.PrimaryWorkspaceId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *StandbyWorkspace) SetTags(v []*Tag) *StandbyWorkspace { + s.Tags = v + return s +} + +// SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value. +func (s *StandbyWorkspace) SetVolumeEncryptionKey(v string) *StandbyWorkspace { + s.VolumeEncryptionKey = &v + return s +} + // Information used to start a WorkSpace. type StartRequest struct { _ struct{} `type:"structure"` @@ -15377,6 +15867,9 @@ type Workspace struct { // The modification states of the WorkSpace. ModificationStates []*ModificationState `type:"list"` + // The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace. + RelatedWorkspaces []*RelatedWorkspaceProperties `type:"list"` + // Indicates whether the data stored on the root volume is encrypted. RootVolumeEncryptionEnabled *bool `type:"boolean"` @@ -15470,6 +15963,12 @@ func (s *Workspace) SetModificationStates(v []*ModificationState) *Workspace { return s } +// SetRelatedWorkspaces sets the RelatedWorkspaces field's value. +func (s *Workspace) SetRelatedWorkspaces(v []*RelatedWorkspaceProperties) *Workspace { + s.RelatedWorkspaces = v + return s +} + // SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value. func (s *Workspace) SetRootVolumeEncryptionEnabled(v bool) *Workspace { s.RootVolumeEncryptionEnabled = &v @@ -15622,6 +16121,9 @@ type WorkspaceBundle struct { // The identifier of the bundle. BundleId *string `type:"string"` + // The type of WorkSpace bundle. + BundleType *string `type:"string" enum:"BundleType"` + // The compute type of the bundle. For more information, see Amazon WorkSpaces // Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). ComputeType *ComputeType `type:"structure"` @@ -15648,6 +16150,9 @@ type WorkspaceBundle struct { // The size of the root volume. RootStorage *RootStorage `type:"structure"` + // The state of the WorkSpace bundle. + State *string `type:"string" enum:"WorkspaceBundleState"` + // The size of the user volume. UserStorage *UserStorage `type:"structure"` } @@ -15676,6 +16181,12 @@ func (s *WorkspaceBundle) SetBundleId(v string) *WorkspaceBundle { return s } +// SetBundleType sets the BundleType field's value. +func (s *WorkspaceBundle) SetBundleType(v string) *WorkspaceBundle { + s.BundleType = &v + return s +} + // SetComputeType sets the ComputeType field's value. func (s *WorkspaceBundle) SetComputeType(v *ComputeType) *WorkspaceBundle { s.ComputeType = v @@ -15724,6 +16235,12 @@ func (s *WorkspaceBundle) SetRootStorage(v *RootStorage) *WorkspaceBundle { return s } +// SetState sets the State field's value. +func (s *WorkspaceBundle) SetState(v string) *WorkspaceBundle { + s.State = &v + return s +} + // SetUserStorage sets the UserStorage field's value. func (s *WorkspaceBundle) SetUserStorage(v *UserStorage) *WorkspaceBundle { s.UserStorage = v @@ -16588,6 +17105,22 @@ func AssociationStatus_Values() []string { } } +const ( + // BundleTypeRegular is a BundleType enum value + BundleTypeRegular = "REGULAR" + + // BundleTypeStandby is a BundleType enum value + BundleTypeStandby = "STANDBY" +) + +// BundleType_Values returns all elements of the BundleType enum +func BundleType_Values() []string { + return []string{ + BundleTypeRegular, + BundleTypeStandby, + } +} + const ( // CertificateBasedAuthStatusEnumDisabled is a CertificateBasedAuthStatusEnum enum value CertificateBasedAuthStatusEnumDisabled = "DISABLED" @@ -16952,6 +17485,22 @@ func SamlStatusEnum_Values() []string { } } +const ( + // StandbyWorkspaceRelationshipTypePrimary is a StandbyWorkspaceRelationshipType enum value + StandbyWorkspaceRelationshipTypePrimary = "PRIMARY" + + // StandbyWorkspaceRelationshipTypeStandby is a StandbyWorkspaceRelationshipType enum value + StandbyWorkspaceRelationshipTypeStandby = "STANDBY" +) + +// StandbyWorkspaceRelationshipType_Values returns all elements of the StandbyWorkspaceRelationshipType enum +func StandbyWorkspaceRelationshipType_Values() []string { + return []string{ + StandbyWorkspaceRelationshipTypePrimary, + StandbyWorkspaceRelationshipTypeStandby, + } +} + const ( // TargetWorkspaceStateAvailable is a TargetWorkspaceState enum value TargetWorkspaceStateAvailable = "AVAILABLE" @@ -16984,6 +17533,26 @@ func Tenancy_Values() []string { } } +const ( + // WorkspaceBundleStateAvailable is a WorkspaceBundleState enum value + WorkspaceBundleStateAvailable = "AVAILABLE" + + // WorkspaceBundleStatePending is a WorkspaceBundleState enum value + WorkspaceBundleStatePending = "PENDING" + + // WorkspaceBundleStateError is a WorkspaceBundleState enum value + WorkspaceBundleStateError = "ERROR" +) + +// WorkspaceBundleState_Values returns all elements of the WorkspaceBundleState enum +func WorkspaceBundleState_Values() []string { + return []string{ + WorkspaceBundleStateAvailable, + WorkspaceBundleStatePending, + WorkspaceBundleStateError, + } +} + const ( // WorkspaceDirectoryStateRegistering is a WorkspaceDirectoryState enum value WorkspaceDirectoryStateRegistering = "REGISTERING" diff --git a/service/workspaces/workspacesiface/interface.go b/service/workspaces/workspacesiface/interface.go index 03295fd47d3..a1b4fd4fcd7 100644 --- a/service/workspaces/workspacesiface/interface.go +++ b/service/workspaces/workspacesiface/interface.go @@ -88,6 +88,10 @@ type WorkSpacesAPI interface { CreateIpGroupWithContext(aws.Context, *workspaces.CreateIpGroupInput, ...request.Option) (*workspaces.CreateIpGroupOutput, error) CreateIpGroupRequest(*workspaces.CreateIpGroupInput) (*request.Request, *workspaces.CreateIpGroupOutput) + CreateStandbyWorkspaces(*workspaces.CreateStandbyWorkspacesInput) (*workspaces.CreateStandbyWorkspacesOutput, error) + CreateStandbyWorkspacesWithContext(aws.Context, *workspaces.CreateStandbyWorkspacesInput, ...request.Option) (*workspaces.CreateStandbyWorkspacesOutput, error) + CreateStandbyWorkspacesRequest(*workspaces.CreateStandbyWorkspacesInput) (*request.Request, *workspaces.CreateStandbyWorkspacesOutput) + CreateTags(*workspaces.CreateTagsInput) (*workspaces.CreateTagsOutput, error) CreateTagsWithContext(aws.Context, *workspaces.CreateTagsInput, ...request.Option) (*workspaces.CreateTagsOutput, error) CreateTagsRequest(*workspaces.CreateTagsInput) (*request.Request, *workspaces.CreateTagsOutput)