diff --git a/CHANGELOG.md b/CHANGELOG.md index 47bc4d47728..005c7ef9780 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +Release v1.42.33 (2022-01-12) +=== + +### Service Client Updates +* `service/ec2`: Updates service API + * Hpc6a instances are powered by a third-generation AMD EPYC processors (Milan) delivering all-core turbo frequency of 3.4 GHz +* `service/elasticache`: Updates service documentation + * Doc only update for ElastiCache +* `service/fms`: Updates service API and documentation +* `service/honeycode`: Updates service API and documentation +* `service/models.lex.v2`: Updates service API and documentation +* `service/pi`: Updates service API, documentation, and paginators + Release v1.42.32 (2022-01-11) === diff --git a/aws/version.go b/aws/version.go index 5530cb8ffcf..5d0766e1688 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.42.32" +const SDKVersion = "1.42.33" diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 62315e3360b..493d998782b 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -23636,6 +23636,7 @@ "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", + "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", diff --git a/models/apis/elasticache/2015-02-02/docs-2.json b/models/apis/elasticache/2015-02-02/docs-2.json index 6890b8d34c5..27ee921bfe4 100644 --- a/models/apis/elasticache/2015-02-02/docs-2.json +++ b/models/apis/elasticache/2015-02-02/docs-2.json @@ -61,7 +61,7 @@ "ModifyUserGroup": "
Changes the list of users that belong to the user group.
", "PurchaseReservedCacheNodesOffering": "Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
", "RebalanceSlotsInGlobalReplicationGroup": "Redistribute slots to ensure uniform distribution across existing shards in the cluster.
", - "RebootCacheCluster": "Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
", + "RebootCacheCluster": "Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
", "RemoveTagsFromResource": "Removes the tags identified by the TagKeys
list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters
and CacheParameterGroupName
parameters.
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
", @@ -315,7 +315,7 @@ } }, "CacheNode": { - "base": "Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The unique ID of the service update
", "CacheCluster$CacheClusterId": "The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
", "CacheCluster$ClientDownloadLandingPage": "The URL of the web page where you can download the latest ElastiCache client library.
", - "CacheCluster$CacheNodeType": "The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The name of the cache engine (memcached
or redis
) to be used for this cluster.
The version of the cache engine that is used in this cluster.
", "CacheCluster$CacheClusterStatus": "The current state of this cluster, one of the following values: available
, creating
, deleted
, deleting
, incompatible-network
, modifying
, rebooting cluster nodes
, restore-failed
, or snapshotting
.
The node group (shard) identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 50 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
This parameter is only valid if the Engine
parameter is redis
.
The EC2 Availability Zone in which the cluster is created.
All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
", - "CreateCacheClusterMessage$CacheNodeType": "The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached
| redis
The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
", "CreateCacheClusterMessage$CacheParameterGroupName": "The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes'
when creating a cluster.
A user-created description for the replication group.
", "CreateReplicationGroupMessage$GlobalReplicationGroupId": "The name of the Global datastore
", "CreateReplicationGroupMessage$PrimaryClusterId": "The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or ReplicasPerNodeGroup
is specified.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
", "CreateReplicationGroupMessage$EngineVersion": "The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions
operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
", "CreateReplicationGroupMessage$CacheParameterGroupName": "The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2
.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on
.
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
", "DescribeReservedCacheNodesMessage$ReservedCacheNodesOfferingId": "The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
", - "DescribeReservedCacheNodesMessage$CacheNodeType": "The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
", "DescribeReservedCacheNodesMessage$OfferingType": "The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward) cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward) cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
", "DescribeReservedCacheNodesOfferingsMessage$OfferingType": "The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"
The primary cluster ID that is applied immediately (if --apply-immediately
was specified), or during the next maintenance window.
The unique identifier for the reservation.
", "ReservedCacheNode$ReservedCacheNodesOfferingId": "The offering identifier.
", - "ReservedCacheNode$CacheNodeType": "The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The description of the reserved cache node.
", "ReservedCacheNode$OfferingType": "The offering type of this reserved cache node.
", "ReservedCacheNode$State": "The state of the reserved cache node.
", "ReservedCacheNode$ReservationARN": "The Amazon Resource Name (ARN) of the reserved cache node.
Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
Provides an identifier to allow retrieval of paginated results.
", "ReservedCacheNodesOffering$ReservedCacheNodesOfferingId": "A unique identifier for the reserved cache node offering.
", - "ReservedCacheNodesOffering$CacheNodeType": "The cache node type for the reserved cache node.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The cache engine used by the offering.
", "ReservedCacheNodesOffering$OfferingType": "The offering type.
", "ReservedCacheNodesOfferingMessage$Marker": "Provides an identifier to allow retrieval of paginated results.
", @@ -2339,7 +2339,7 @@ "Snapshot$CacheClusterId": "The user-supplied identifier of the source cluster.
", "Snapshot$SnapshotStatus": "The status of the snapshot. Valid values: creating
| available
| restoring
| copying
| deleting
.
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types: cache.m5.large
, cache.m5.xlarge
, cache.m5.2xlarge
, cache.m5.4xlarge
, cache.m5.12xlarge
, cache.m5.24xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro
, cache.t4g.small
, cache.t4g.medium
T3 node types: cache.t3.micro
, cache.t3.small
, cache.t3.medium
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
For region availability, see Supported Node Types
For region availability, see Supported Node Types
R5 node types: cache.r5.large
, cache.r5.xlarge
, cache.r5.2xlarge
, cache.r5.4xlarge
, cache.r5.12xlarge
, cache.r5.24xlarge
R4 node types: cache.r4.large
, cache.r4.xlarge
, cache.r4.2xlarge
, cache.r4.4xlarge
, cache.r4.8xlarge
, cache.r4.16xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.
The name of the cache engine (memcached
or redis
) used by the source cluster.
The version of the cache engine version that is used by the source cluster.
", "Snapshot$PreferredAvailabilityZone": "The name of the Availability Zone in which the source cluster is located.
", diff --git a/models/apis/fms/2018-01-01/api-2.json b/models/apis/fms/2018-01-01/api-2.json index 4c82da9ad19..f25fcd457c5 100644 --- a/models/apis/fms/2018-01-01/api-2.json +++ b/models/apis/fms/2018-01-01/api-2.json @@ -1011,7 +1011,7 @@ }, "ManagedServiceData":{ "type":"string", - "max":4096, + "max":8192, "min":1, "pattern":".*" }, diff --git a/models/apis/fms/2018-01-01/docs-2.json b/models/apis/fms/2018-01-01/docs-2.json index fad864dd22a..e795eb44ffb 100644 --- a/models/apis/fms/2018-01-01/docs-2.json +++ b/models/apis/fms/2018-01-01/docs-2.json @@ -24,7 +24,7 @@ "ListTagsForResource": "Retrieves the list of tags for the specified Amazon Web Services resource.
", "PutAppsList": "Creates an Firewall Manager applications list.
", "PutNotificationChannel": "Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS
to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.
Creates an Firewall Manager policy.
Firewall Manager provides the following types of policies:
An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL.
An WAF Classic policy (type WAF), which defines a rule group.
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.
A security group policy, which manages VPC security groups across your Amazon Web Services organization.
An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs.
Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
", + "PutPolicy": "Creates an Firewall Manager policy.
Firewall Manager provides the following types of policies:
An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL.
An WAF Classic policy (type WAF), which defines a rule group.
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.
A security group policy, which manages VPC security groups across your Amazon Web Services organization.
An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs.
Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
", "PutProtocolsList": "Creates an Firewall Manager protocols list.
", "TagResource": "Adds one or more tags to an Amazon Web Services resource.
", "UntagResource": "Removes one or more tags from an Amazon Web Services resource.
" @@ -156,10 +156,10 @@ "NetworkFirewallInvalidRouteConfigurationViolation$IsRouteTableUsedInDifferentAZ": "Information about whether the route table is used in another Availability Zone.
", "Policy$ExcludeResourceTags": "If set to True
, resources with the tags that are specified in the ResourceTag
array are not in scope of the policy. If set to False
, and the ResourceTag
array is not null, only resources with the specified tags are in scope of the policy.
Indicates if the policy should be automatically applied to new resources.
", - "Policy$DeleteUnusedFMManagedResources": "Indicates whether Firewall Manager should delete Firewall Manager managed resources, such as web ACLs and security groups, when they are not in use by the Firewall Manager policy. By default, Firewall Manager doesn't delete unused Firewall Manager managed resources. This option is not available for Shield Advanced or WAF Classic policies.
", + "Policy$DeleteUnusedFMManagedResources": "Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.
By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic policies.
", "PolicyComplianceDetail$EvaluationLimitExceeded": "Indicates if over 100 resources are noncompliant with the Firewall Manager policy.
", "PolicySummary$RemediationEnabled": "Indicates if the policy should be automatically applied to new resources.
", - "PolicySummary$DeleteUnusedFMManagedResources": "Indicates whether Firewall Manager should delete Firewall Manager managed resources, such as web ACLs and security groups, when they are not in use by the Firewall Manager policy. By default, Firewall Manager doesn't delete unused Firewall Manager managed resources. This option is not available for Shield Advanced or WAF Classic policies.
", + "PolicySummary$DeleteUnusedFMManagedResources": "Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.
By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic policies.
", "PossibleRemediationAction$IsDefaultAction": "Information about whether an action is taken by default.
", "SecurityGroupRemediationAction$IsDefaultAction": "Indicates if the current action is the default action.
" } @@ -603,7 +603,7 @@ "ManagedServiceData": { "base": null, "refs": { - "SecurityServicePolicyData$ManagedServiceData": "Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED
, this is an empty string.
Example: DNS_FIREWALL
\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"
Valid values for preProcessRuleGroups
are between 1 and 99. Valid values for postProcessRuleGroups
are between 9901 and 10000.
Example: NETWORK_FIREWALL
\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\\\",\\\"priority\\\":10}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:pass\\\",\\\"custom1\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"custom2\\\",\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"custom1\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension1\\\"}]}}},{\\\"actionName\\\":\\\"custom2\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension2\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":true,\\\"allowedIPV4CidrList\\\":[\\\"10.24.34.0/28\\\"]} }\"
Example: WAFV2
\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"
In the loggingConfiguration
, you can specify one logDestinationConfigs
, you can optionally provide up to 20 redactedFields
, and the RedactedFieldType
must be one of URI
, QUERY_STRING
, HEADER
, or METHOD
.
Example: WAF Classic
\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"
Example: SECURITY_GROUPS_COMMON
\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns
\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"
Example: SECURITY_GROUPS_CONTENT_AUDIT
\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"
The security group action for content audit can be ALLOW
or DENY
. For ALLOW
, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY
, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT
\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"
Details about the service that are specific to the service type, in JSON format.
Example: DNS_FIREWALL
\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"
Valid values for preProcessRuleGroups
are between 1 and 99. Valid values for postProcessRuleGroups
are between 9901 and 10000.
Example: NETWORK_FIREWALL
\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\\\",\\\"priority\\\":10}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:pass\\\",\\\"custom1\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"custom2\\\",\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"custom1\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension1\\\"}]}}},{\\\"actionName\\\":\\\"custom2\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension2\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":true,\\\"allowedIPV4CidrList\\\":[\\\"10.24.34.0/28\\\"]} }\"
Specification for SHIELD_ADVANCED
for Amazon CloudFront distributions
\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false}\"
For example: \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\", \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"
The default value for automaticResponseStatus
is IGNORED
. The value for automaticResponseAction
is only required when automaticResponseStatus
is set to ENABLED
. The default value for overrideCustomerWebaclClassic
is false
.
For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData
configuration is an empty string.
Example: WAFV2
\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"
In the loggingConfiguration
, you can specify one logDestinationConfigs
, you can optionally provide up to 20 redactedFields
, and the RedactedFieldType
must be one of URI
, QUERY_STRING
, HEADER
, or METHOD
.
Example: WAF Classic
\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"
Example: SECURITY_GROUPS_COMMON
\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns
\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"
Example: SECURITY_GROUPS_CONTENT_AUDIT
\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"
The security group action for content audit can be ALLOW
or DENY
. For ALLOW
, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY
, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT
\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"
The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer
, AWS::CloudFront::Distribution
, or AWS::NetworkFirewall::FirewallPolicy
.
The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance
, AWS::EC2::NetworkInterface
, AWS::EC2::SecurityGroup
, AWS::NetworkFirewall::FirewallPolicy
, and AWS::EC2::Subnet
.
The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList
and then specify the resource types in a ResourceTypeList
.
For WAF and Shield Advanced, example resource types include AWS::ElasticLoadBalancingV2::LoadBalancer
and AWS::CloudFront::Distribution
. For a security group common policy, valid values are AWS::EC2::NetworkInterface
and AWS::EC2::Instance
. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup
, AWS::EC2::NetworkInterface
, and AWS::EC2::Instance
. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup
. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC
.
The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList
and then specify the resource types in a ResourceTypeList
.
For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer
, AWS::ElasticLoadBalancing::LoadBalancer
, AWS::EC2::EIP
, and AWS::CloudFront::Distribution
. For a security group common policy, valid values are AWS::EC2::NetworkInterface
and AWS::EC2::Instance
. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup
, AWS::EC2::NetworkInterface
, and AWS::EC2::Instance
. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup
. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC
.
The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. For WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer
and AWS::CloudFront::Distribution
. For a security group common policy, valid values are AWS::EC2::NetworkInterface
and AWS::EC2::Instance
. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup
, AWS::EC2::NetworkInterface
, and AWS::EC2::Instance
. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup
. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC
.
The resource type that the violation details were requested for.
" diff --git a/models/apis/honeycode/2020-03-01/api-2.json b/models/apis/honeycode/2020-03-01/api-2.json index e83f84a8554..58703ffbcf3 100644 --- a/models/apis/honeycode/2020-03-01/api-2.json +++ b/models/apis/honeycode/2020-03-01/api-2.json @@ -196,6 +196,24 @@ {"shape":"ValidationException"} ] }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, "QueryTableRows":{ "name":"QueryTableRows", "http":{ @@ -230,6 +248,42 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] } }, "shapes":{ @@ -837,6 +891,23 @@ "workbookCursor":{"shape":"WorkbookCursor"} } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "tags":{"shape":"TagsMap"} + } + }, "MaxResults":{ "type":"integer", "box":true, @@ -907,6 +978,12 @@ }, "exception":true }, + "ResourceArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^arn:aws:honeycode:.+:[0-9]{12}:.+:.+$" + }, "ResourceId":{ "type":"string", "max":36, @@ -1114,6 +1191,49 @@ "type":"list", "member":{"shape":"Table"} }, + "TagKey":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" + }, + "TagKeysList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":100 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"TagsMap"} + } + }, + "TagResourceResult":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":100 + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -1123,6 +1243,30 @@ "exception":true }, "TimestampInMillis":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeysList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResult":{ + "type":"structure", + "members":{ + } + }, "UpdateRowData":{ "type":"structure", "required":[ diff --git a/models/apis/honeycode/2020-03-01/docs-2.json b/models/apis/honeycode/2020-03-01/docs-2.json index beab7a4eb8f..28beb2ae994 100644 --- a/models/apis/honeycode/2020-03-01/docs-2.json +++ b/models/apis/honeycode/2020-03-01/docs-2.json @@ -12,8 +12,11 @@ "ListTableColumns": "The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
", "ListTableRows": "The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
", "ListTables": "The ListTables API allows you to retrieve a list of all the tables in a workbook.
", + "ListTagsForResource": "The ListTagsForResource API allows you to return a resource's tags.
", "QueryTableRows": "The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
", - "StartTableDataImportJob": "The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.
" + "StartTableDataImportJob": "The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.
", + "TagResource": "The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
", + "UntagResource": "The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
" }, "shapes": { "AccessDeniedException": { @@ -376,6 +379,16 @@ "refs": { } }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResult": { + "base": null, + "refs": { + } + }, "MaxResults": { "base": null, "refs": { @@ -430,6 +443,14 @@ "refs": { } }, + "ResourceArn": { + "base": null, + "refs": { + "ListTagsForResourceRequest$resourceArn": "The resource's Amazon Resource Name (ARN).
", + "TagResourceRequest$resourceArn": "The resource's Amazon Resource Name (ARN).
", + "UntagResourceRequest$resourceArn": "The resource's Amazon Resource Name (ARN).
" + } + }, "ResourceId": { "base": null, "refs": { @@ -444,7 +465,7 @@ "DescribeTableDataImportJobRequest$workbookId": "The ID of the workbook into which data was imported.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
", "DescribeTableDataImportJobRequest$tableId": "The ID of the table into which data was imported.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
", "GetScreenDataRequest$workbookId": "The ID of the workbook that contains the screen.
", - "GetScreenDataRequest$appId": "The ID of the app that contains the screem.
", + "GetScreenDataRequest$appId": "The ID of the app that contains the screen.
", "GetScreenDataRequest$screenId": "The ID of the screen.
", "ImportColumnMap$key": null, "InvokeScreenAutomationRequest$workbookId": "The ID of the workbook that contains the screen automation.
", @@ -643,6 +664,42 @@ "ListTablesResult$tables": "The list of tables in the workbook.
" } }, + "TagKey": { + "base": null, + "refs": { + "TagKeysList$member": null, + "TagsMap$key": null + } + }, + "TagKeysList": { + "base": "A list of tag keys
", + "refs": { + "UntagResourceRequest$tagKeys": "A list of tag keys to remove from the resource.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResult": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagsMap$value": null + } + }, + "TagsMap": { + "base": "A string to string map representing tags
", + "refs": { + "ListTagsForResourceResult$tags": "The resource's tags.
", + "TagResourceRequest$tags": "A list of tags to apply to the resource.
" + } + }, "ThrottlingException": { "base": "Tps(transactions per second) rate reached.
", "refs": { @@ -654,6 +711,16 @@ "TableDataImportJobMetadata$submitTime": "The timestamp when the job was submitted for import.
" } }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResult": { + "base": null, + "refs": { + } + }, "UpdateRowData": { "base": "Data needed to create a single row in a table as part of the BatchCreateTableRows request.
", "refs": { diff --git a/models/apis/models.lex.v2/2020-08-07/api-2.json b/models/apis/models.lex.v2/2020-08-07/api-2.json index 9699b66481d..65d48057615 100644 --- a/models/apis/models.lex.v2/2020-08-07/api-2.json +++ b/models/apis/models.lex.v2/2020-08-07/api-2.json @@ -301,6 +301,24 @@ {"shape":"InternalServerException"} ] }, + "DeleteCustomVocabulary":{ + "name":"DeleteCustomVocabulary", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary", + "responseCode":202 + }, + "input":{"shape":"DeleteCustomVocabularyRequest"}, + "output":{"shape":"DeleteCustomVocabularyResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "DeleteExport":{ "name":"DeleteExport", "http":{ @@ -517,6 +535,23 @@ {"shape":"InternalServerException"} ] }, + "DescribeCustomVocabularyMetadata":{ + "name":"DescribeCustomVocabularyMetadata", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/metadata", + "responseCode":200 + }, + "input":{"shape":"DescribeCustomVocabularyMetadataRequest"}, + "output":{"shape":"DescribeCustomVocabularyMetadataResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, "DescribeExport":{ "name":"DescribeExport", "http":{ @@ -1107,6 +1142,12 @@ } }, "shapes":{ + "AdvancedRecognitionSetting":{ + "type":"structure", + "members":{ + "audioRecognitionStrategy":{"shape":"AudioRecognitionStrategy"} + } + }, "AggregatedUtterancesFilter":{ "type":"structure", "required":[ @@ -1243,6 +1284,10 @@ "max":1, "min":1 }, + "AudioRecognitionStrategy":{ + "type":"string", + "enum":["UseSlotValuesAsCustomVocabulary"] + }, "Boolean":{"type":"boolean"}, "BotAliasHistoryEvent":{ "type":"structure", @@ -2230,6 +2275,42 @@ "max":1000, "min":1 }, + "CustomVocabularyExportSpecification":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"BotVersion"}, + "localeId":{"shape":"LocaleId"} + } + }, + "CustomVocabularyImportSpecification":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"} + } + }, + "CustomVocabularyStatus":{ + "type":"string", + "enum":[ + "Ready", + "Deleting", + "Exporting", + "Importing", + "Creating" + ] + }, "DataPrivacy":{ "type":"structure", "required":["childDirected"], @@ -2369,6 +2450,40 @@ "botStatus":{"shape":"BotStatus"} } }, + "DeleteCustomVocabularyRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DeleteCustomVocabularyResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "customVocabularyStatus":{"shape":"CustomVocabularyStatus"} + } + }, "DeleteExportRequest":{ "type":"structure", "required":["exportId"], @@ -2777,6 +2892,42 @@ "creationDateTime":{"shape":"Timestamp"} } }, + "DescribeCustomVocabularyMetadataRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DescribeCustomVocabularyMetadataResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"BotVersion"}, + "localeId":{"shape":"LocaleId"}, + "customVocabularyStatus":{"shape":"CustomVocabularyStatus"}, + "creationDateTime":{"shape":"Timestamp"}, + "lastUpdatedDateTime":{"shape":"Timestamp"} + } + }, "DescribeExportRequest":{ "type":"structure", "required":["exportId"], @@ -3070,7 +3221,8 @@ "type":"structure", "members":{ "botExportSpecification":{"shape":"BotExportSpecification"}, - "botLocaleExportSpecification":{"shape":"BotLocaleExportSpecification"} + "botLocaleExportSpecification":{"shape":"BotLocaleExportSpecification"}, + "customVocabularyExportSpecification":{"shape":"CustomVocabularyExportSpecification"} } }, "ExportSortAttribute":{ @@ -3236,7 +3388,10 @@ }, "ImportExportFileFormat":{ "type":"string", - "enum":["LexJson"] + "enum":[ + "LexJson", + "TSV" + ] }, "ImportExportFilePassword":{ "type":"string", @@ -3278,9 +3433,18 @@ "type":"structure", "members":{ "botImportSpecification":{"shape":"BotImportSpecification"}, - "botLocaleImportSpecification":{"shape":"BotLocaleImportSpecification"} + "botLocaleImportSpecification":{"shape":"BotLocaleImportSpecification"}, + "customVocabularyImportSpecification":{"shape":"CustomVocabularyImportSpecification"} } }, + "ImportResourceType":{ + "type":"string", + "enum":[ + "Bot", + "BotLocale", + "CustomVocabulary" + ] + }, "ImportSortAttribute":{ "type":"string", "enum":["LastUpdatedDateTime"] @@ -3314,7 +3478,8 @@ "importStatus":{"shape":"ImportStatus"}, "mergeStrategy":{"shape":"MergeStrategy"}, "creationDateTime":{"shape":"Timestamp"}, - "lastUpdatedDateTime":{"shape":"Timestamp"} + "lastUpdatedDateTime":{"shape":"Timestamp"}, + "importedResourceType":{"shape":"ImportResourceType"} } }, "ImportSummaryList":{ @@ -3702,7 +3867,8 @@ "sortBy":{"shape":"ExportSortBy"}, "filters":{"shape":"ExportFilters"}, "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"} + "nextToken":{"shape":"NextToken"}, + "localeId":{"shape":"LocaleId"} } }, "ListExportsResponse":{ @@ -3711,7 +3877,8 @@ "botId":{"shape":"Id"}, "botVersion":{"shape":"BotVersion"}, "exportSummaries":{"shape":"ExportSummaryList"}, - "nextToken":{"shape":"NextToken"} + "nextToken":{"shape":"NextToken"}, + "localeId":{"shape":"LocaleId"} } }, "ListImportsRequest":{ @@ -3722,7 +3889,8 @@ "sortBy":{"shape":"ImportSortBy"}, "filters":{"shape":"ImportFilters"}, "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"} + "nextToken":{"shape":"NextToken"}, + "localeId":{"shape":"LocaleId"} } }, "ListImportsResponse":{ @@ -3731,7 +3899,8 @@ "botId":{"shape":"Id"}, "botVersion":{"shape":"DraftBotVersion"}, "importSummaries":{"shape":"ImportSummaryList"}, - "nextToken":{"shape":"NextToken"} + "nextToken":{"shape":"NextToken"}, + "localeId":{"shape":"LocaleId"} } }, "ListIntentsRequest":{ @@ -4596,7 +4765,8 @@ "required":["resolutionStrategy"], "members":{ "resolutionStrategy":{"shape":"SlotValueResolutionStrategy"}, - "regexFilter":{"shape":"SlotValueRegexFilter"} + "regexFilter":{"shape":"SlotValueRegexFilter"}, + "advancedRecognitionSetting":{"shape":"AdvancedRecognitionSetting"} } }, "SortOrder":{ diff --git a/models/apis/models.lex.v2/2020-08-07/docs-2.json b/models/apis/models.lex.v2/2020-08-07/docs-2.json index 7c3db0ade85..8b81520a4da 100644 --- a/models/apis/models.lex.v2/2020-08-07/docs-2.json +++ b/models/apis/models.lex.v2/2020-08-07/docs-2.json @@ -18,6 +18,7 @@ "DeleteBotAlias": "Deletes the specified bot alias.
", "DeleteBotLocale": "Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
", "DeleteBotVersion": "Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.
", + "DeleteCustomVocabulary": "Removes a custom vocabulary from the specified locale in the specified bot.
", "DeleteExport": "Removes a previous export and the associated files stored in an S3 bucket.
", "DeleteImport": "Removes a previous import and the associated file stored in an S3 bucket.
", "DeleteIntent": "Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
", @@ -31,6 +32,7 @@ "DescribeBotLocale": "Describes the settings that a bot has for a specific locale.
", "DescribeBotRecommendation": "Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.
", "DescribeBotVersion": "Provides metadata about a version of a bot.
", + "DescribeCustomVocabularyMetadata": "Provides metadata information about a custom vocabulary.
", "DescribeExport": "Gets information about a specific export.
", "DescribeImport": "Gets information about a specific import.
", "DescribeIntent": "Returns metadata about an intent.
", @@ -45,8 +47,8 @@ "ListBots": "Gets a list of available bots.
", "ListBuiltInIntents": "Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature
parameter when you call the CreateIntent
operation. For more information, see CreateIntent.
Gets a list of built-in slot types that meet the specified criteria.
", - "ListExports": "Lists the exports for a bot or bot locale. Exports are kept in the list for 7 days.
", - "ListImports": "Lists the imports for a bot or bot locale. Imports are kept in the list for 7 days.
", + "ListExports": "Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
", + "ListImports": "Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
", "ListIntents": "Get a list of intents that meet the specified criteria.
", "ListRecommendedIntents": "Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
", "ListSlotTypes": "Gets a list of slot types that match the specified criteria.
", @@ -54,7 +56,7 @@ "ListTagsForResource": "Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
", "SearchAssociatedTranscripts": "Search for associated transcripts that meet the specified criteria.
", "StartBotRecommendation": "Use this to provide your transcript data, and to start the bot recommendation process.
", - "StartImport": "Starts importing a bot or bot locale from a zip archive that you uploaded to an S3 bucket.
", + "StartImport": "Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
", "TagResource": "Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
", "UntagResource": "Removes tags from a bot, bot alias, or bot channel.
", "UpdateBot": "Updates the configuration of an existing bot.
", @@ -68,6 +70,12 @@ "UpdateSlotType": "Updates the configuration of an existing slot type.
" }, "shapes": { + "AdvancedRecognitionSetting": { + "base": "Provides settings that enable advanced recognition settings for slot values.
", + "refs": { + "SlotValueSelectionSetting$advancedRecognitionSetting": "Provides settings that enable advanced recognition settings for slot values.
" + } + }, "AggregatedUtterancesFilter": { "base": "Filters responses returned by the ListAggregatedUtterances
operation.
The Amazon S3 settings for logging audio to an S3 bucket.
" } }, + "AudioRecognitionStrategy": { + "base": null, + "refs": { + "AdvancedRecognitionSetting$audioRecognitionStrategy": "Enables using the slot values as a custom vocabulary for recognizing user utterances.
" + } + }, "Boolean": { "base": null, "refs": { @@ -480,9 +494,12 @@ "BotLocaleExportSpecification$botVersion": "The version of the bot to export.
", "BotVersionLocaleDetails$sourceBotVersion": "The version of a bot used for a bot locale.
", "BotVersionSummary$botVersion": "The numeric version of the bot, or DRAFT
to indicate that this is the version of the bot that can be updated..
The version of the bot that contains the custom vocabulary to export.
", "DescribeBotAliasResponse$botVersion": "The version of the bot associated with the bot alias.
", "DescribeBotLocaleRequest$botVersion": "The identifier of the version of the bot associated with the locale.
", "DescribeBotLocaleResponse$botVersion": "The identifier of the version of the bot associated with the locale.
", + "DescribeCustomVocabularyMetadataRequest$botVersion": "The bot version of the bot to return metadata for.
", + "DescribeCustomVocabularyMetadataResponse$botVersion": "The version of the bot that contains the custom vocabulary to describe.
", "DescribeIntentRequest$botVersion": "The version of the bot associated with the intent.
", "DescribeSlotRequest$botVersion": "The version of the bot associated with the slot.
", "DescribeSlotResponse$botVersion": "The version of the bot associated with the slot.
", @@ -885,6 +902,25 @@ "CustomPayload$value": "The string that is sent to your application.
" } }, + "CustomVocabularyExportSpecification": { + "base": "Provides the parameters required for exporting a custom vocabulary.
", + "refs": { + "ExportResourceSpecification$customVocabularyExportSpecification": "The parameters required to export a custom vocabulary.
" + } + }, + "CustomVocabularyImportSpecification": { + "base": "Provides the parameters required for importing a custom vocabulary.
", + "refs": { + "ImportResourceSpecification$customVocabularyImportSpecification": null + } + }, + "CustomVocabularyStatus": { + "base": null, + "refs": { + "DeleteCustomVocabularyResponse$customVocabularyStatus": "The status of removing the custom vocabulary.
", + "DescribeCustomVocabularyMetadataResponse$customVocabularyStatus": "The status of the custom vocabulary. If the status is Ready
the custom vocabulary is ready to use.
By default, data stored by Amazon Lex is encrypted. The DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
The version of the bot associated with the slot.
", "CreateSlotTypeRequest$botVersion": "The identifier of the bot version associated with this slot type.
", "CreateSlotTypeResponse$botVersion": "The version of the bot associated with the slot type.
", + "CustomVocabularyImportSpecification$botVersion": "The version of the bot to import the custom vocabulary to.
", "DeleteBotLocaleRequest$botVersion": "The version of the bot that contains the locale.
", "DeleteBotLocaleResponse$botVersion": "The version of the bot that contained the deleted locale.
", + "DeleteCustomVocabularyRequest$botVersion": "The version of the bot to remove the custom vocabulary from.
", + "DeleteCustomVocabularyResponse$botVersion": "The version of the bot that the custom vocabulary was removed from.
", "DeleteIntentRequest$botVersion": "The version of the bot associated with the intent.
", "DeleteSlotRequest$botVersion": "The version of the bot associated with the slot to delete.
", "DeleteSlotTypeRequest$botVersion": "The version of the bot associated with the slot type.
", @@ -1360,8 +1419,8 @@ "AssociatedTranscriptFilter$values": "The values to use to filter the transcript.
", "BotFilter$values": "The value to use for filtering the list of bots.
", "BotLocaleFilter$values": "The value to use for filtering the list of bots.
", - "ExportFilter$values": "The values to use to filter the response.
", - "ImportFilter$values": "The values to use to filter the response.
", + "ExportFilter$values": "The values to use to filter the response. The values must be Bot
, BotLocale
, or CustomVocabulary
.
The values to use to filter the response. The values must be Bot
, BotLocale
, or CustomVocabulary
.
The value to use for the filter.
", "SlotFilter$values": "The value to use to filter the response.
", "SlotTypeFilter$values": "The value to use to filter the response.
" @@ -1461,6 +1520,8 @@ "CreateSlotTypeResponse$slotTypeId": "The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType
and DeleteSlotType
operations.
The identifier for the bot associated with the slot type.
", "CreateUploadUrlResponse$importId": "An identifier for a unique import job. Use it when you call the StartImport operation.
", + "CustomVocabularyExportSpecification$botId": "The identifier of the bot that contains the custom vocabulary to export.
", + "CustomVocabularyImportSpecification$botId": "The identifier of the bot to import the custom vocabulary to.
", "DeleteBotAliasRequest$botId": "The unique identifier of the bot associated with the alias to delete.
", "DeleteBotAliasResponse$botId": "The unique identifier of the bot that contains the alias to delete.
", "DeleteBotLocaleRequest$botId": "The unique identifier of the bot that contains the locale.
", @@ -1469,6 +1530,8 @@ "DeleteBotResponse$botId": "The unique identifier of the bot that Amazon Lex is deleting.
", "DeleteBotVersionRequest$botId": "The identifier of the bot that contains the version.
", "DeleteBotVersionResponse$botId": "The identifier of the bot that is being deleted.
", + "DeleteCustomVocabularyRequest$botId": "The unique identifier of the bot to remove the custom vocabulary from.
", + "DeleteCustomVocabularyResponse$botId": "The identifier of the bot that the custom vocabulary was removed from.
", "DeleteExportRequest$exportId": "The unique identifier of the export to delete.
", "DeleteExportResponse$exportId": "The unique identifier of the deleted export.
", "DeleteImportRequest$importId": "The unique identifier of the import to delete.
", @@ -1493,6 +1556,8 @@ "DescribeBotResponse$botId": "The unique identifier of the bot.
", "DescribeBotVersionRequest$botId": "The identifier of the bot containing the version to return metadata for.
", "DescribeBotVersionResponse$botId": "The identifier of the bot that contains the version.
", + "DescribeCustomVocabularyMetadataRequest$botId": "The unique identifier of the bot that contains the custom vocabulary.
", + "DescribeCustomVocabularyMetadataResponse$botId": "The identifier of the bot that contains the custom vocabulary.
", "DescribeExportRequest$exportId": "The unique identifier of the export to describe.
", "DescribeExportResponse$exportId": "The unique identifier of the described export.
", "DescribeImportRequest$importId": "The unique identifier of the import to describe.
", @@ -1592,16 +1657,16 @@ "refs": { "CreateExportRequest$fileFormat": "The file format of the bot or bot locale definition files.
", "CreateExportResponse$fileFormat": "The file format used for the bot or bot locale definition files.
", - "DescribeExportResponse$fileFormat": "The file format used in the files that describe the bot or bot locale.
", + "DescribeExportResponse$fileFormat": "The file format used in the files that describe the resource.
", "ExportSummary$fileFormat": "The file format used in the export files.
", - "UpdateExportResponse$fileFormat": "The file format used for the files that define the resource.
" + "UpdateExportResponse$fileFormat": "The file format used for the files that define the resource. The TSV
format is required to export a custom vocabulary only; otherwise use LexJson
format.
An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
", - "StartImportRequest$filePassword": "The password used to encrypt the zip archive that contains the bot or bot locale definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
", + "StartImportRequest$filePassword": "The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
", "UpdateExportRequest$filePassword": "The new password to use to encrypt the export zip archive.
" } }, @@ -1632,9 +1697,15 @@ "ImportResourceSpecification": { "base": "Provides information about the bot or bot locale that you want to import. You can specify the botImportSpecification
or the botLocaleImportSpecification
, but not both.
The specifications of the imported bot or bot locale.
", - "StartImportRequest$resourceSpecification": "Parameters for creating the bot or bot locale.
", - "StartImportResponse$resourceSpecification": "The parameters used when importing the bot or bot locale.
" + "DescribeImportResponse$resourceSpecification": "The specifications of the imported bot, bot locale, or custom vocabulary.
", + "StartImportRequest$resourceSpecification": "Parameters for creating the bot, bot locale or custom vocabulary.
", + "StartImportResponse$resourceSpecification": "The parameters used when importing the resource.
" + } + }, + "ImportResourceType": { + "base": null, + "refs": { + "ImportSummary$importedResourceType": "The type of resource that was imported.
" } }, "ImportSortAttribute": { @@ -1655,7 +1726,7 @@ "DeleteImportResponse$importStatus": "The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will fail.
", "DescribeImportResponse$importStatus": "The status of the import process. When the status is Completed
the resource is imported and ready for use.
The status of the resource. When the status is Completed
the resource is ready to build.
The current status of the import. When the status is Complete
the bot or bot alias is ready to use.
The current status of the import. When the status is Complete
the bot, bot alias, or custom vocabulary is ready to use.
The language and local specified for the slot.
", "CreateSlotTypeRequest$localeId": "The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
", "CreateSlotTypeResponse$localeId": "The specified language and local specified for the slot type.
", + "CustomVocabularyExportSpecification$localeId": "The locale of the bot that contains the custom vocabulary to export.
", + "CustomVocabularyImportSpecification$localeId": "The identifier of the local to import the custom vocabulary to. The value must be en_GB
.
The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
", "DeleteBotLocaleResponse$localeId": "The language and locale of the deleted locale.
", + "DeleteCustomVocabularyRequest$localeId": "The locale identifier for the locale that contains the custom vocabulary to remove.
", + "DeleteCustomVocabularyResponse$localeId": "The locale identifier for the locale that the custom vocabulary was removed from.
", "DeleteIntentRequest$localeId": "The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
", "DeleteSlotRequest$localeId": "The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
", "DeleteSlotTypeRequest$localeId": "The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
", @@ -2006,6 +2081,8 @@ "DescribeBotLocaleResponse$localeId": "The unique identifier of the described locale.
", "DescribeBotRecommendationRequest$localeId": "The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
", "DescribeBotRecommendationResponse$localeId": "The identifier of the language and locale of the bot recommendation to describe.
", + "DescribeCustomVocabularyMetadataRequest$localeId": "The locale to return the custom vocabulary information for. The locale must be en_GB
.
The locale that contains the custom vocabulary to describe.
", "DescribeIntentRequest$localeId": "The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
", "DescribeIntentResponse$localeId": "The language and locale specified for the intent.
", "DescribeSlotRequest$localeId": "The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
", @@ -2020,6 +2097,10 @@ "ListBuiltInIntentsResponse$localeId": "The language and locale of the intents in the list.
", "ListBuiltInSlotTypesRequest$localeId": "The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
", "ListBuiltInSlotTypesResponse$localeId": "The language and locale of the slot types in the list.
", + "ListExportsRequest$localeId": "Specifies the resources that should be exported. If you don't specify a resource type in the filters
parameter, both bot locales and custom vocabularies are exported.
The locale specified in the request.
", + "ListImportsRequest$localeId": "Specifies the locale that should be present in the list. If you don't specify a resource type in the filters
parameter, the list contains both bot locales and custom vocabularies.
The locale specified in the request.
", "ListIntentsRequest$localeId": "The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
", "ListIntentsResponse$localeId": "The language and locale of the intents in the list.
", "ListRecommendedIntentsRequest$localeId": "The identifier of the language and locale of the recommended intents.
", @@ -2198,17 +2279,17 @@ "ListBotRecommendationsResponse$nextToken": "A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.
", "ListBotVersionsRequest$nextToken": "If the response to the ListBotVersion
operation contains more results than specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
A token that indicates whether there are more results to return in a response to the ListBotVersions
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a ListBotAliases
operation request to get the next page of results.
If the response from the ListBots
operation contains more results than specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
If the response from the ListBots
operation contains more results than specified in the maxResults
parameter, a token is returned in the response.
Use the returned token in the nextToken
parameter of a ListBots
request to return the next page of results. For a complete set of results, call the ListBots
operation until the nextToken
returned in the response is null.
A token that indicates whether there are more results to return in a response to the ListBots
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a ListBots
operation request to get the next page of results.
If the response from the ListBuiltInIntents
operation contains more results than specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
A token that indicates whether there are more results to return in a response to the ListBuiltInIntents
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a ListBotAliases
operation request to get the next page of results.
If the response from the ListBuiltInSlotTypes
operation contains more results than specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
A token that indicates whether there are more results to return in a response to the ListBuiltInSlotTypes
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a LIstBuiltInSlotTypes
operation request to get the next page of results.
If the response from the ListExports
operation contains more results that specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
If the response from the ListExports
operation contains more results that specified in the maxResults
parameter, a token is returned in the response.
Use the returned token in the nextToken
parameter of a ListExports
request to return the next page of results. For a complete set of results, call the ListExports
operation until the nextToken
returned in the response is null.
A token that indicates whether there are more results to return in a response to the ListExports
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a ListExports
operation request to get the next page of results.
If the response from the ListImports
operation contains more results than specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
If the response from the ListImports
operation contains more results than specified in the maxResults
parameter, a token is returned in the response.
Use the returned token in the nextToken
parameter of a ListImports
request to return the next page of results. For a complete set of results, call the ListImports
operation until the nextToken
returned in the response is null.
A token that indicates whether there are more results to return in a response to the ListImports
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a ListImports
operation request to get the next page of results.
If the response from the ListIntents
operation contains more results than specified in the maxResults
parameter, a token is returned in the response. Use that token in the nextToken
parameter to return the next page of results.
If the response from the ListIntents
operation contains more results than specified in the maxResults
parameter, a token is returned in the response.
Use the returned token in the nextToken
parameter of a ListIntents
request to return the next page of results. For a complete set of results, call the ListIntents
operation until the nextToken
returned in the response is null.
A token that indicates whether there are more results to return in a response to the ListIntents
operation. If the nextToken
field is present, you send the contents as the nextToken
parameter of a ListIntents
operation request to get the next page of results.
If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
", "ListRecommendedIntentsResponse$nextToken": "A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
", @@ -2998,6 +3079,8 @@ "DescribeBotResponse$creationDateTime": "A timestamp of the date and time that the bot was created.
", "DescribeBotResponse$lastUpdatedDateTime": "A timestamp of the date and time that the bot was last updated.
", "DescribeBotVersionResponse$creationDateTime": "A timestamp of the date and time that the bot version was created.
", + "DescribeCustomVocabularyMetadataResponse$creationDateTime": "The date and time that the custom vocabulary was created.
", + "DescribeCustomVocabularyMetadataResponse$lastUpdatedDateTime": "The date and time that the custom vocabulary was last updated.
", "DescribeExportResponse$creationDateTime": "The date and time that the export was created.
", "DescribeExportResponse$lastUpdatedDateTime": "The last date and time that the export was updated.
", "DescribeImportResponse$creationDateTime": "The date and time that the import was created.
", diff --git a/models/apis/pi/2018-02-27/api-2.json b/models/apis/pi/2018-02-27/api-2.json index 8cb458830da..bfe4e2c04b4 100644 --- a/models/apis/pi/2018-02-27/api-2.json +++ b/models/apis/pi/2018-02-27/api-2.json @@ -42,6 +42,20 @@ {"shape":"NotAuthorizedException"} ] }, + "GetResourceMetadata":{ + "name":"GetResourceMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourceMetadataRequest"}, + "output":{"shape":"GetResourceMetadataResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, "GetResourceMetrics":{ "name":"GetResourceMetrics", "http":{ @@ -55,9 +69,48 @@ {"shape":"InternalServiceError"}, {"shape":"NotAuthorizedException"} ] + }, + "ListAvailableResourceDimensions":{ + "name":"ListAvailableResourceDimensions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableResourceDimensionsRequest"}, + "output":{"shape":"ListAvailableResourceDimensionsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] + }, + "ListAvailableResourceMetrics":{ + "name":"ListAvailableResourceMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableResourceMetricsRequest"}, + "output":{"shape":"ListAvailableResourceMetricsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ] } }, "shapes":{ + "AdditionalMetricsList":{ + "type":"list", + "member":{"shape":"RequestString"}, + "max":30, + "min":1 + }, + "AdditionalMetricsMap":{ + "type":"map", + "key":{"shape":"RequestString"}, + "value":{"shape":"Double"} + }, "DataPoint":{ "type":"structure", "required":[ @@ -91,6 +144,7 @@ "Metric":{"shape":"RequestString"}, "PeriodInSeconds":{"shape":"Integer"}, "GroupBy":{"shape":"DimensionGroup"}, + "AdditionalMetrics":{"shape":"AdditionalMetricsList"}, "PartitionBy":{"shape":"DimensionGroup"}, "Filter":{"shape":"MetricQueryFilterMap"}, "MaxResults":{"shape":"MaxResults"}, @@ -107,6 +161,11 @@ "NextToken":{"shape":"NextToken"} } }, + "Description":{ + "type":"string", + "max":2048, + "min":1 + }, "DetailStatus":{ "type":"string", "enum":[ @@ -115,6 +174,16 @@ "UNAVAILABLE" ] }, + "DimensionDetail":{ + "type":"structure", + "members":{ + "Identifier":{"shape":"String"} + } + }, + "DimensionDetailList":{ + "type":"list", + "member":{"shape":"DimensionDetail"} + }, "DimensionGroup":{ "type":"structure", "required":["Group"], @@ -124,11 +193,23 @@ "Limit":{"shape":"Limit"} } }, + "DimensionGroupDetail":{ + "type":"structure", + "members":{ + "Group":{"shape":"String"}, + "Dimensions":{"shape":"DimensionDetailList"} + } + }, + "DimensionGroupDetailList":{ + "type":"list", + "member":{"shape":"DimensionGroupDetail"} + }, "DimensionKeyDescription":{ "type":"structure", "members":{ "Dimensions":{"shape":"DimensionMap"}, "Total":{"shape":"Double"}, + "AdditionalMetrics":{"shape":"AdditionalMetricsMap"}, "Partitions":{"shape":"MetricValuesList"} } }, @@ -153,8 +234,36 @@ "key":{"shape":"RequestString"}, "value":{"shape":"RequestString"} }, + "DimensionsMetricList":{ + "type":"list", + "member":{"shape":"RequestString"}, + "max":5, + "min":1 + }, "Double":{"type":"double"}, "ErrorString":{"type":"string"}, + "FeatureMetadata":{ + "type":"structure", + "members":{ + "Status":{"shape":"FeatureStatus"} + } + }, + "FeatureMetadataMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"FeatureMetadata"} + }, + "FeatureStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "UNSUPPORTED", + "ENABLED_PENDING_REBOOT", + "DISABLED_PENDING_REBOOT", + "UNKNOWN" + ] + }, "GetDimensionKeyDetailsRequest":{ "type":"structure", "required":[ @@ -177,6 +286,24 @@ "Dimensions":{"shape":"DimensionKeyDetailList"} } }, + "GetResourceMetadataRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"RequestString"} + } + }, + "GetResourceMetadataResponse":{ + "type":"structure", + "members":{ + "Identifier":{"shape":"String"}, + "Features":{"shape":"FeatureMetadataMap"} + } + }, "GetResourceMetricsRequest":{ "type":"structure", "required":[ @@ -235,11 +362,66 @@ "max":10, "min":1 }, + "ListAvailableResourceDimensionsRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "Metrics" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"RequestString"}, + "Metrics":{"shape":"DimensionsMetricList"}, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListAvailableResourceDimensionsResponse":{ + "type":"structure", + "members":{ + "MetricDimensions":{"shape":"MetricDimensionsList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListAvailableResourceMetricsRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "MetricTypes" + ], + "members":{ + "ServiceType":{"shape":"ServiceType"}, + "Identifier":{"shape":"RequestString"}, + "MetricTypes":{"shape":"MetricTypeList"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + } + }, + "ListAvailableResourceMetricsResponse":{ + "type":"structure", + "members":{ + "Metrics":{"shape":"ResponseResourceMetricList"}, + "NextToken":{"shape":"NextToken"} + } + }, "MaxResults":{ "type":"integer", "max":20, "min":0 }, + "MetricDimensionGroups":{ + "type":"structure", + "members":{ + "Metric":{"shape":"String"}, + "Groups":{"shape":"DimensionGroupDetailList"} + } + }, + "MetricDimensionsList":{ + "type":"list", + "member":{"shape":"MetricDimensionGroups"} + }, "MetricKeyDataPoints":{ "type":"structure", "members":{ @@ -271,6 +453,10 @@ "max":15, "min":1 }, + "MetricTypeList":{ + "type":"list", + "member":{"shape":"RequestString"} + }, "MetricValuesList":{ "type":"list", "member":{"shape":"Double"} @@ -317,6 +503,14 @@ "type":"list", "member":{"shape":"ResponsePartitionKey"} }, + "ResponseResourceMetric":{ + "type":"structure", + "members":{ + "Metric":{"shape":"String"}, + "Description":{"shape":"Description"}, + "Unit":{"shape":"String"} + } + }, "ResponseResourceMetricKey":{ "type":"structure", "required":["Metric"], @@ -325,9 +519,16 @@ "Dimensions":{"shape":"DimensionMap"} } }, + "ResponseResourceMetricList":{ + "type":"list", + "member":{"shape":"ResponseResourceMetric"} + }, "ServiceType":{ "type":"string", - "enum":["RDS"] + "enum":[ + "RDS", + "DOCDB" + ] }, "String":{ "type":"string", diff --git a/models/apis/pi/2018-02-27/docs-2.json b/models/apis/pi/2018-02-27/docs-2.json index c822018e527..63c9b5ae6a8 100644 --- a/models/apis/pi/2018-02-27/docs-2.json +++ b/models/apis/pi/2018-02-27/docs-2.json @@ -1,12 +1,27 @@ { "version": "2.0", - "service": "Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for AWS service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as Average Active Sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
For a specific time period, retrieve the top N
dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails
retrieves the full text of the dimension db.sql.statement
associated with this ID. This operation is useful because GetResourceMetrics
and DescribeDimensionKeys
don't support retrieval of large SQL statement text.
Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
For a specific time period, retrieve the top N
dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails
retrieves the full text of the dimension db.sql.statement
cassociated with this ID. This operation is useful because GetResourceMetrics
and DescribeDimensionKeys
don't support retrieval of large SQL statement text.
Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
", + "GetResourceMetrics": "Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
", + "ListAvailableResourceMetrics": "Retrieve metrics of the specified types that can be queried for a specified DB instance.
" }, "shapes": { + "AdditionalMetricsList": { + "base": null, + "refs": { + "DescribeDimensionKeysRequest$AdditionalMetrics": "Additional metrics for the top N
dimension keys. If the specified dimension group in the GroupBy
parameter is db.sql_tokenized
, you can specify per-SQL metrics to get the values for the top N
SQL digests. The response syntax is \"AdditionalMetrics\" : { \"string\" : \"string\" }
.
A map that contains the value for each additional metric.
" + } + }, "DataPoint": { "base": "A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
", "refs": { @@ -29,22 +44,52 @@ "refs": { } }, + "Description": { + "base": null, + "refs": { + "ResponseResourceMetric$Description": "The description of the metric.
" + } + }, "DetailStatus": { "base": null, "refs": { "DimensionKeyDetail$Status": "The status of the dimension detail data. Possible values include the following:
AVAILABLE
- The dimension detail data is ready to be retrieved.
PROCESSING
- The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data for db.sql.statement
has the status PROCESSING
, Performance Insights returns the truncated query.
UNAVAILABLE
- The dimension detail data could not be collected successfully.
The information about a dimension.
", + "refs": { + "DimensionDetailList$member": null + } + }, + "DimensionDetailList": { + "base": null, + "refs": { + "DimensionGroupDetail$Dimensions": "The dimensions within a dimension group.
" + } + }, "DimensionGroup": { "base": "A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql
dimension group consists of the following dimensions: db.sql.id
, db.sql.db_id
, db.sql.statement
, and db.sql.tokenized_id
.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
", - "DescribeDimensionKeysRequest$PartitionBy": "For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the partition keys in the response.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
", + "DescribeDimensionKeysRequest$PartitionBy": "For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the partition keys in the response.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
" } }, + "DimensionGroupDetail": { + "base": "Information about dimensions within a dimension group.
", + "refs": { + "DimensionGroupDetailList$member": null + } + }, + "DimensionGroupDetailList": { + "base": null, + "refs": { + "MetricDimensionGroups$Groups": "The available dimension groups for a metric type.
" + } + }, "DimensionKeyDescription": { - "base": "An array of descriptions and aggregated values for each dimension within a dimension group.
", + "base": "An object that includes the requested dimension key values and aggregated metric values within a dimension group.
", "refs": { "DimensionKeyDescriptionList$member": null } @@ -71,15 +116,22 @@ "base": null, "refs": { "DimensionKeyDescription$Dimensions": "A map of name-value pairs for the dimensions in the group.
", - "ResponsePartitionKey$Dimensions": "A dimension map that contains the dimension(s) for this partition.
", + "ResponsePartitionKey$Dimensions": "A dimension map that contains the dimensions for this partition.
", "ResponseResourceMetricKey$Dimensions": "The valid dimensions for the metric.
" } }, + "DimensionsMetricList": { + "base": null, + "refs": { + "ListAvailableResourceDimensionsRequest$Metrics": "The types of metrics for which to retrieve dimensions. Valid values include db.load
.
The actual value associated with a particular Timestamp
.
The aggregated metric value for the dimension(s), over the requested time range.
", + "DimensionKeyDescription$Total": "The aggregated metric value for the dimensions, over the requested time range.
", "MetricValuesList$member": null } }, @@ -91,6 +143,24 @@ "NotAuthorizedException$Message": null } }, + "FeatureMetadata": { + "base": "The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
", + "refs": { + "FeatureMetadataMap$value": null + } + }, + "FeatureMetadataMap": { + "base": null, + "refs": { + "GetResourceMetadataResponse$Features": "The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
" + } + }, + "FeatureStatus": { + "base": null, + "refs": { + "FeatureMetadata$Status": "The status of the feature on the DB instance. Possible values include the following:
ENABLED
: the feature is enabled on the instance.
DISABLED
: the feature is disabled on the instance.
UNSUPPORTED
: the feature isn't supported on the instance.
ENABLED_PENDING_REBOOT
: the feature is enabled on the instance but requires a reboot to take effect.
DISABLED_PENDING_REBOOT
: the feature is disabled on the instance but requires a reboot to take effect.
UNKNOWN
: the feature status couldn't be determined.
The time, in epoch format, associated with a particular Value
.
The date and time specifying the beginning of the requested time series data. You must specify a StartTime
within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the beginning of the requested time series data. You must specify a StartTime
within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime
are returned.
The value for EndTime
must be later than the value for StartTime
.
The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
The date and time specifying the beginning of the requested time series data. You can't specify a StartTime
that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime
will be returned.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime
will be returned.
The value for EndTime
must be later than the value for StartTime
.
The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS Region. When a DB instance is the data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don't specify PeriodInSeconds
, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.
The maximum number of items to fetch for this dimension group.
" } }, + "ListAvailableResourceDimensionsRequest": { + "base": null, + "refs": { + } + }, + "ListAvailableResourceDimensionsResponse": { + "base": null, + "refs": { + } + }, + "ListAvailableResourceMetricsRequest": { + "base": null, + "refs": { + } + }, + "ListAvailableResourceMetricsResponse": { + "base": null, + "refs": { + } + }, "MaxResults": { "base": null, "refs": { "DescribeDimensionKeysRequest$MaxResults": "The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return. If the MaxRecords
value is less than the number of existing items, the response includes a pagination token.
The available dimension information for a metric type.
", + "refs": { + "MetricDimensionsList$member": null + } + }, + "MetricDimensionsList": { + "base": null, + "refs": { + "ListAvailableResourceDimensionsResponse$MetricDimensions": "The dimension information returned for requested metric types.
" } }, "MetricKeyDataPoints": { @@ -174,7 +288,7 @@ } }, "MetricQuery": { - "base": "A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy
), and return only those data points that match your criteria (Filter
).
A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy
), and return only those data points that match your criteria (Filter
).
An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.
" } }, + "MetricTypeList": { + "base": null, + "refs": { + "ListAvailableResourceMetricsRequest$MetricTypes": "The types of metrics to return in the response. Valid values in the array include the following:
os
(OS counter metrics)
db
(DB load metrics)
db.sql.stats
(per-SQL metrics)
db.sql_tokenized.stats
(per-SQL digest metrics)
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the previous request. To get the remaining records, specify NextToken
in a separate request with this value.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the previous request. To get the remaining records, specify NextToken
in a separate request with this value.
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
The name of the dimension group. Valid values are:
db
- The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)
db.application
- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
db.host
- The host name of the connected client (all engines)
db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.sql
- The SQL that is currently executing (all engines)
db.sql_tokenized
- The SQL digest (all engines)
db.wait_event
- The event for which the database backend is waiting (all engines)
db.wait_event_type
- The type of event for which the database backend is waiting (all engines)
db.user
- The user logged in to the database (all engines)
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
The name of the dimension group. Valid values are:
db
- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
db.application
- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
db.host
- The host name of the connected client (all engines)
db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.sql
- The SQL that is currently executing (all engines)
db.sql_tokenized
- The SQL digest (all engines)
db.wait_event
- The event for which the database backend is waiting (all engines)
db.wait_event_type
- The type of event for which the database backend is waiting (all engines)
db.user
- The user logged in to the database (all engines)
The name of the dimension group. The only valid value is db.sql
. Performance Insights searches the specified group for the dimension group ID.
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql
, the group ID is db.sql.id
.
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ
.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ
.
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
Valid values for elements in the Dimensions
array are:
db.application.name
- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
db.host.id
- The host ID of the connected client (all engines)
db.host.name
- The host name of the connected client (all engines)
db.name
- The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)
db.session_type.name
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.sql.id
- The SQL ID generated by Performance Insights (all engines)
db.sql.db_id
- The SQL ID generated by the database (all engines)
db.sql.statement
- The SQL text that is being executed (all engines)
db.sql.tokenized_id
db.sql_tokenized.id
- The SQL digest ID generated by Performance Insights (all engines)
db.sql_tokenized.db_id
- SQL digest ID generated by the database (all engines)
db.sql_tokenized.statement
- The SQL digest text (all engines)
db.user.id
- The ID of the user logged in to the database (all engines)
db.user.name
- The name of the user logged in to the database (all engines)
db.wait_event.name
- The event for which the backend is waiting (all engines)
db.wait_event.type
- The type of event for which the backend is waiting (all engines)
db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines)
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
Valid values for elements in the Dimensions
array are:
db.application.name
- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
db.host.id
- The host ID of the connected client (all engines)
db.host.name
- The host name of the connected client (all engines)
db.name
- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
db.session_type.name
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.sql.id
- The SQL ID generated by Performance Insights (all engines)
db.sql.db_id
- The SQL ID generated by the database (all engines)
db.sql.statement
- The SQL text that is being executed (all engines)
db.sql.tokenized_id
db.sql_tokenized.id
- The SQL digest ID generated by Performance Insights (all engines)
db.sql_tokenized.db_id
- SQL digest ID generated by the database (all engines)
db.sql_tokenized.statement
- The SQL digest text (all engines)
db.user.id
- The ID of the user logged in to the database (all engines)
db.user.name
- The name of the user logged in to the database (all engines)
db.wait_event.name
- The event for which the backend is waiting (all engines)
db.wait_event.type
- The type of event for which the backend is waiting (all engines)
db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines)
A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group db.sql
, specify either the full dimension name db.sql.statement
or the short dimension name statement
. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group.
A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group db.sql
, specify either the full dimension name db.sql.statement
or the short dimension name statement
. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group.
If PartitionBy
was present in the request, PartitionKeys
contains the breakdown of dimension keys by the specified partitions.
If PartitionBy
was present in the request, PartitionKeys
contains the breakdown of dimension keys by the specified partitions.
An object that contains the full name, description, and unit of a metric.
", + "refs": { + "ResponseResourceMetricList$member": null } }, "ResponseResourceMetricKey": { "base": "An object describing a Performance Insights metric and one or more dimensions for that metric.
", "refs": { - "MetricKeyDataPoints$Key": "The dimension(s) to which the data points apply.
" + "MetricKeyDataPoints$Key": "The dimensions to which the data points apply.
" + } + }, + "ResponseResourceMetricList": { + "base": null, + "refs": { + "ListAvailableResourceMetricsResponse$Metrics": "An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.
" } }, "ServiceType": { "base": null, "refs": { - "DescribeDimensionKeysRequest$ServiceType": "The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS
.
The AWS service for which Performance Insights returns data. The only valid value is RDS
.
The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS
.
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS
.
The Amazon Web Services service for which Performance Insights returns metrics.
", + "GetResourceMetricsRequest$ServiceType": "The Amazon Web Services service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS
.
The Amazon Web Services service for which Performance Insights returns metrics.
", + "ListAvailableResourceMetricsRequest$ServiceType": "The Amazon Web Services service for which Performance Insights returns metrics.
" } }, "String": { "base": null, "refs": { + "DimensionDetail$Identifier": "The identifier of a dimension.
", + "DimensionGroupDetail$Group": "The name of the dimension group.
", "DimensionKeyDetail$Value": "The value of the dimension detail data. For the db.sql.statement
dimension, this value is either the full or truncated SQL query, depending on the return status.
The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement
.
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use a DB instance as a data source, you specify its DbiResourceId
value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use a DB instance as a data source, you specify its DbiResourceId
value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A
The metric type to which the dimension information belongs.
", + "ResponseResourceMetric$Metric": "The full name of the metric.
", + "ResponseResourceMetric$Unit": "The unit of the metric.
", "ResponseResourceMetricKey$Metric": "The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.