+ * This value is set to "true" by default which means SDK will automatically use system property values for options that + * are not provided during building the {@link ProxyConfiguration} object. To disable this behavior, set this value to + * "false".It is important to note that when this property is set to "true," all proxy settings will exclusively originate + * from system properties, and no partial settings will be obtained from EnvironmentVariableValues. */ Builder useSystemPropertyValues(Boolean useSystemPropertyValues); + /** + * Option whether to use environment variable values for proxy configuration if any of the config options are missing. + *
+ * This value is set to "true" by default, which means the SDK will automatically use environment variable values for + * proxy configuration options that are not provided during the building of the {@link ProxyConfiguration} object. To + * disable this behavior, set this value to "false". It is important to note that when this property is set to "true," all + * proxy settings will exclusively originate from environment variableValues, and no partial settings will be obtained + * from SystemPropertyValues. + * + * @param useEnvironmentVariableValues The option whether to use environment variable values. + * @return This object for method chaining. + */ + Builder useEnvironmentVariableValues(Boolean useEnvironmentVariableValues); + + /** + * The HTTP scheme to use for connecting to the proxy. Valid values are {@code http} and {@code https}. + *
+ * The client defaults to {@code http} if none is given.
+ *
+ * @param scheme The proxy scheme.
+ * @return This object for method chaining.
+ */
+ Builder scheme(String scheme);
+
}
/**
@@ -307,6 +323,8 @@ private static final class DefaultClientProxyConfigurationBuilder implements Bui
private Set
+ * This value is set to "true" by default which means SDK will automatically use system property values for options that
+ * are not provided during building the {@link ProxyConfiguration} object. To disable this behavior, set this value to
+ * "false".It is important to note that when this property is set to "true," all proxy settings will exclusively originate
+ * from system properties, and no partial settings will be obtained from EnvironmentVariableValues
*/
Builder useSystemPropertyValues(Boolean useSystemPropertyValues);
+ /**
+ * Option whether to use environment variable values from {@link ProxyEnvironmentSetting} if any of the config options are
+ * missing. This value is set to "true" by default, which means SDK will automatically use environment variable values for
+ * options that are not provided during building the {@link ProxyConfiguration} object. To disable this behavior, set this
+ * value to "false".It is important to note that when this property is set to "true," all proxy settings will exclusively
+ * originate from environment variableValues, and no partial settings will be obtained from SystemPropertyValues.
+ *
+ * @param useEnvironmentVariablesValues The option whether to use environment variable values
+ * @return This object for method chaining.
+ */
+ Builder useEnvironmentVariablesValues(Boolean useEnvironmentVariablesValues);
+
+ /**
+ * The HTTP scheme to use for connecting to the proxy. Valid values are {@code http} and {@code https}.
+ *
+ * The client defaults to {@code http} if none is given.
+ *
+ * @param scheme The proxy scheme.
+ * @return This object for method chaining.
+ */
+ Builder scheme(String scheme);
}
/**
@@ -226,9 +269,11 @@ private static final class DefaultClientProxyConfigurationBuilder implements Bui
private URI endpoint;
private String username;
+ private String scheme = "http";
private String password;
private Set DocumentTableSchema specifying primaryKey, sortKey and a customAttributeConverter can be created as below
* {@snippet :
* DocumentTableSchema documentTableSchema = DocumentTableSchema.builder()
- * .primaryKey("sampleHashKey", AttributeValueType.S)
- * .sortKey("sampleSortKey", AttributeValueType.S)
+ * .addIndexPartitionKey("sampleIndexName", "sampleHashKey", AttributeValueType.S)
+ * .addIndexSortKey("sampleIndexName", "sampleSortKey", AttributeValueType.S)
* .attributeConverterProviders(customAttributeConverter, AttributeConverterProvider.defaultProvider())
* .build();
*}
diff --git a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/ReadBatch.java b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/ReadBatch.java
index e9d4364fec81..6292efdfc5b1 100644
--- a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/ReadBatch.java
+++ b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/ReadBatch.java
@@ -167,6 +167,9 @@ private static The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue). Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target. The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. To create a lifecycle hook for scale-out events, specify To create a lifecycle hook for scale-in events, specify Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue. If you specify an empty string, this overrides the current ARN. This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic. When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. Returns a list of The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified For accurate reporting on the compliance status, you must record the Returns a list of The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. You can have only one delivery channel per region in your account. Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic. Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. You can have only one delivery channel per region in your account. The configuration item status. The valid values are: OK – The resource configuration has been updated ResourceDiscovered – The resource was newly discovered ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type ResourceDeleted – The resource was deleted ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type The CIs do not incur any cost. The configuration item status. The valid values are: OK – The resource configuration has been updated ResourceDiscovered – The resource was newly discovered ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type ResourceDeleted – The resource was deleted ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type The configuration item status. The valid values are: OK – The resource configuration has been updated ResourceDiscovered – The resource was newly discovered ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type ResourceDeleted – The resource was deleted ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type The CIs do not incur any cost. The configuration item status. The valid values are: OK – The resource configuration has been updated ResourceDiscovered – The resource was newly discovered ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type ResourceDeleted – The resource was deleted ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type The mode of an evaluation. The valid values are Detective or Proactive. The configuration object for Config rule evaluation mode. The Supported valid values are Detective or Proactive. The configuration object for Config rule evaluation mode. The supported valid values are Detective or Proactive. A comma-separated list of resource types to exclude from recording by the configuration recorder. Specifies whether the configuration recorder excludes resource types from being recorded. Use the Specifies whether the configuration recorder excludes certain resource types from being recorded. Use the By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically. How to use To use this option, you must set the Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded. Globally recorded resources Unless specifically listed as exclusions, Asia Pacific (Hyderabad) Asia Pacific (Melbourne) Europe (Spain) Europe (Zurich) Israel (Tel Aviv) Middle East (UAE) The time stamp that indicates a later time. If not specified, current time is taken. The chronologically latest time in the time range for which the history requested. If not specified, current time is taken. The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded. The chronologically earliest time in the time range for which the history requested. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded. The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. The location of the file containing the template body ( You must have access to read Amazon S3 bucket. The location of the file containing the template body ( You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed. Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB). You must have access to read Amazon S3 bucket. Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB). You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed. Specifies whether Config records configuration changes for all supported regional resource types. If you set this field to If you set this field to Specifies whether Config records configuration changes for all supported regionally recorded resource types. If you set this field to If you set this field to Region Availability Check Resource Coverage by Region Availability to see if a resource type is supported in the Amazon Web Services Region where you set up Config. Specifies whether Config records configuration changes for all supported global resources. Before you set this field to If you set this field to If you set this field to If you do not want to record configuration changes to global resource types, make sure to not list them in the A legacy field which only applies to the globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies. If you select this option, these resource types will be recorded in all enabled Config regions where Config was available before February 2022. This list does not include the following Regions: Asia Pacific (Hyderabad) Asia Pacific (Melbourne) Europe (Spain) Europe (Zurich) Israel (Tel Aviv) Middle East (UAE) Aurora global clusters are automatically globally recorded The If you do not want to record Record all current and future resource types with exclusions ( Record specific resource types ( For more information, see Selecting Which Resources are Recorded in the Config developer guide. Required and optional fields Before you set this field to Overriding fields If you set this field to If you do not want to record configuration changes to the globally recorded IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the An object that specifies the recording strategy for the configuration recorder. If you set the If you set the If you set the The The The If you choose For example, even if you set By default, if you choose the An object that specifies the recording strategy for the configuration recorder. If you set the If you set the If you set the Required and optional fields The The The Overriding fields If you choose For example, even if you set Global resources types and the resource exclusion recording strategy By default, if you choose the In addition, unless specifically listed as exclusions, Asia Pacific (Hyderabad) Asia Pacific (Melbourne) Europe (Spain) Europe (Zurich) Israel (Tel Aviv) Middle East (UAE) Specifies which resource types Config records for configuration changes. In the recording group, you specify whether you want to record all supported resource types or to include or exclude specific types of resources. By default, Config records configuration changes for all supported types of Regional resources that Config discovers in the Amazon Web Services Region in which it is running. Regional resources are tied to a Region and can be used only in that Region. Examples of Regional resources are Amazon EC2 instances and Amazon EBS volumes. You can also have Config record supported types of global resources. Global resources are not tied to a specific Region and can be used in all Regions. The global resource types that Config supports include IAM users, groups, roles, and customer managed policies. Global resource types onboarded to Config recording after February 2022 will be recorded only in the service's home Region for the commercial partition and Amazon Web Services GovCloud (US-West) for the Amazon Web Services GovCloud (US) partition. You can view the Configuration Items for these new global resource types only in their home Region and Amazon Web Services GovCloud (US-West). If you don't want Config to record all resources, you can specify which types of resources Config records with the For a list of supported resource types, see Supported Resource Types in the Config developer guide. For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records in the Config developer guide. Specifies which resource types Config records for configuration changes. By default, Config records configuration changes for all current and future supported resource types in the Amazon Web Services Region where you have enabled Config (excluding the globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies). In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see Supported Resource Types in the Config developer guide. If you don't want Config to record all current and future supported resource types, use one of the following recording strategies: Record all current and future resource types with exclusions ( Record specific resource types ( Aurora global clusters are automatically globally recorded The If you do not want to record The recording strategy for the configuration recorder. If you set this option to When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide. If you set this option to If you set this option to The The The If you choose For example, even if you set By default, if you choose the The recording strategy for the configuration recorder. If you set this option to If you set this option to If you set this option to Required and optional fields The The The Overriding fields If you choose For example, even if you set Global resource types and the exclusion recording strategy By default, if you choose the In addition, unless specifically listed as exclusions, Asia Pacific (Hyderabad) Asia Pacific (Melbourne) Europe (Spain) Europe (Zurich) Israel (Tel Aviv) Middle East (UAE) Specifies the recording strategy of the configuration recorder. This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the AWS Control Tower User Guide . This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the AWS Control Tower User Guide Returns the status of a particular Returns the status of a particular Provides details about the enabled control. For usage examples, see the AWS Control Tower User Guide . Returned values TargetRegions: Shows target AWS Regions where the enabled control is available to be deployed. StatusSummary: Provides a detailed summary of the deployment status. DriftSummary: Provides a detailed summary of the drifted status. Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains. Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the AWS Control Tower User Guide User does not have sufficient access to perform this action. User does not have sufficient access to perform this action. The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail. The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the The ARN of the organizational unit. The ARN of the organizational unit. For information on how to find the The drift status of the enabled control. Valid values: The drift summary of the enabled control. AWS Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control. The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail. The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the The ARN of the organizational unit. The ARN of the organizational unit. For information on how to find the The ARN of the enabled control. The control identifier of the enabled control. For information on how to find the The drift status of the enabled control. The deployment summary of the enabled control. The ARN of the organizational unit. For information on how to find the Target AWS Regions for the enabled control. Information about the enabled control. The ARN of the enabled control. The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail. The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the The drift status of the enabled control. The ARN of the organizational unit. A summary of enabled controls. The last operation identifier for the enabled control. The deployment status of the enabled control. Valid values: The deployment summary of the enabled control. An operation performed by the control. The ARN of the enabled control. Information about the enabled control. The ARN of the organizational unit. The ARN of the organizational unit. For information on how to find the The AWS Region name. An AWS Region in which AWS Control Tower expects to find the control deployed. The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance. Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails. To call these APIs, you'll need to know: the and the ARN associated with the target organizational unit (OU). To get the The ARN format: Example: To get the ARN for an OU: In the AWS Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU. OU ARN format: Details and examples To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower Recording API Requests AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide. These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically. In AWS Control Tower, the terms \"control\" and \"guardrail\" are synonyms. . To call these APIs, you'll need to know: the the ARN associated with the target organizational unit (OU), which we call the To get the The The A quick-reference list of control identifers for the AWS Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and guardrails in the Controls reference guide section of the AWS Control Tower User Guide. Remember that Mandatory controls cannot be added or removed. ARN format: Example: To get the The In the AWS Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU. OU ARN format: Details and examples To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower Recording API Requests AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide. The display name of the calculated attribute. The description of the calculated attribute. The display name of the calculated attribute. The description of the calculated attribute. The display name of the calculated attribute. The description of the calculated attribute. The display name of the calculated attribute. The threshold for the calculated attribute. The display name of the calculated attribute. The description of the calculated attribute. The display name of the calculated attribute. The description of the calculated attribute. Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. Sets the AMI state to A disabled AMI can't be shared. If a public or shared AMI was previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI. A disabled AMI does not appear in DescribeImages API calls by default. Only the AMI owner can disable an AMI. You can re-enable a disabled AMI using EnableImage. For more information, see Disable an AMI in the Amazon EC2 User Guide. Enables fast snapshot restores for the specified snapshots in the specified Availability Zones. You get the full benefit of fast snapshot restores after they enter the For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide. Re-enables a disabled AMI. The re-enabled AMI is marked as Only the AMI owner can re-enable a disabled AMI. For more information, see Disable an AMI in the Amazon EC2 User Guide. The filters. The filters. Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are included in the response. If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter. Specifies whether to include disabled AMIs. Default: No disabled AMIs are included in the response. Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is The filters. The filters. When you specify the The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the The ID of the AMI. Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is Returns The ID of the AMI. Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is Returns The hypervisor type of the image. The hypervisor type of the image. Only If The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage. Describes an image. Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets. When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets. Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets. When you specify subnets for a Network Load Balancer, or Gateway Load Balancer you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets. The name of the attribute. The following attributes are supported by all load balancers: The following attributes are supported by both Application Load Balancers and Network Load Balancers: The following attributes are supported by only Application Load Balancers: If the value is If the value is If the value is The name of the attribute. The following attributes are supported by all load balancers: The following attributes are supported by both Application Load Balancers and Network Load Balancers: The following attributes are supported by only Application Load Balancers: If the value is If the value is If the value is The following attributes are supported by only Network Load Balancers: The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. [Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are [Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are [Gateway Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are [Network Load Balancers] The IP address type. [Network Load Balancers] The IP address type. [Gateway Load Balancers] The IP address type. The provider for the remote repository. The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET. The name of the remote repository that contains the job artifacts. The name of the remote repository that contains the job artifacts. For BitBucket providers, The provider for the remote repository. The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET. The name of the remote repository that contains the job artifacts. The name of the remote repository that contains the job artifacts. For BitBucket providers, Creates a filter resource using specified filter criteria. Creates a filter resource using specified filter criteria. When the filter action is set to The scan status code to filter on. The scan status code to filter on. Valid values are: Contains information on the resources involved in a finding. Contains information on the resources involved in a finding. The The severity of the finding. The severity of the finding. The type of the finding. The type of the finding. The The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The maximum number of results to return in the response. The maximum number of results the response can return. If your request would return more than the maximum the response will return a A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the The reason for the scan. The scan status. Possible return values and descriptions are: The source of the vulnerability information. The source of the vulnerability information. Possible results are Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments. Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments. Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. The participant’s browser. The participant’s browser version. ISO 8601 timestamp (returned as a string) when the participant first joined the stage session. The participant’s Internet Service Provider. The participant’s operating system. The participant’s operating system version. Unique identifier for this participant, assigned by IVS. Whether the participant ever published to the stage session. The participant’s SDK version. Whether the participant is connected to or disconnected from the stage. A list of VPC security group IDs. Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC. The ID of the VPC. Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. The VPC security groups and subnets that are attached to a Lambda function. Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. Creates a geofence collection, which manages and stores geofences. Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer. For more information, see Using API keys. Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details. Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details. Creates a route calculator resource in your Amazon Web Services account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details. Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices. Deletes a geofence collection from your Amazon Web Services account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored. Deletes the specified API key. The API key must have been deactivated more than 90 days previously. Deletes a map resource from your Amazon Web Services account. This operation deletes the resource permanently. If the map is being used in an application, the map may not render. Deletes a place index resource from your Amazon Web Services account. This operation deletes the resource permanently. Deletes a route calculator resource from your Amazon Web Services account. This operation deletes the resource permanently. Deletes a tracker resource from your Amazon Web Services account. This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications. Retrieves the geofence collection details. Retrieves the API key resource details. Retrieves the map resource details. Retrieves the place index resource details. Retrieves the route calculator resource details. Retrieves the tracker resource details. Removes the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences. Lists geofence collections in your Amazon Web Services account. Lists API key resources in your Amazon Web Services account. Lists map resources in your Amazon Web Services account. Lists place index resources in your Amazon Web Services account. Lists route calculator resources in your Amazon Web Services account. Returns a list of tags that are applied to the specified Amazon Location resource. Lists geofence collections currently associated to the given tracker resource. Lists tracker resources in your Amazon Web Services account. Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the You can associate up to 50 tags with a resource. Removes one or more tags from the specified Amazon Location resource. Updates the specified properties of a given geofence collection. Updates the specified properties of a given API key resource. Updates the specified properties of a given map resource. Updates the specified properties of a given place index resource. Updates the specified properties for a given route calculator resource. Updates the specified properties of a given tracker resource. The password to be used by Amazon ML to connect to a database on an RDS DB instance. The password should have sufficient permissions to execute the A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster. The password should have sufficient permissions to execute a This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). This returns the URL that you can retrieve your Price List file from. This URL is based on the This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). This returns the URL that you can retrieve your Price List file from. This URL is based on the This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). This returns a list of Price List references that the requester if authorized to view, given a This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). This returns a list of Price List references that the requester if authorized to view, given a The unique identifier that maps to where your Price List files are located. The unique identifier that maps to where your Price List files are located. The format that you want to retrieve your Price List files in. The The format that you want to retrieve your Price List files in. The The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use To retrieve the Compute Savings Plan price lists, use The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use To retrieve the Reserved Instance and Compute Savings Plan price lists, use To retrieve Machine Learning Savings Plans price lists, use This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Build cost control and scenario planning tools Reconcile billing data Forecast future spend for budgeting purposes Provide cost benefit analysis that compare your internal workloads with Amazon Web Services Use You can use the following endpoints for the Amazon Web Services Price List API: https://api.pricing.us-east-1.amazonaws.com https://api.pricing.ap-south-1.amazonaws.com The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Build cost control and scenario planning tools Reconcile billing data Forecast future spend for budgeting purposes Provide cost benefit analysis that compare your internal workloads with Amazon Web Services Use For more information, see Using the Amazon Web Services Price List API in the Billing User Guide. The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to Indicates whether the DB instance has a dedicated log volume (DLV) enabled. The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: Must be the identifier of an existing Multi-AZ DB cluster. Can't be specified if the The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported. Indicates whether the DB instance has a dedicated log volume (DLV) enabled. The progress of the storage optimization operation as a percentage. Indicates whether the DB instance has a dedicated log volume (DLV) enabled. Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. Indicates whether the DB instance has a dedicated log volume (DLV) enabled. An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance. The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB. Indicates whether the DB instance has a dedicated log volume (DLV) enabled. Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB. Note the following requirements: Make sure that you specify Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU. Note the following limitations: You can't convert a CDB to a non-CDB. You can't convert a replica database. You can't convert a non-CDB to a CDB and upgrade the engine version in the same command. You can't convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with Indicates whether the DB instance has a dedicated log volume (DLV) enabled. Maximum storage throughput to provisioned IOPS ratio for a DB instance. Indicates whether a DB instance supports using a dedicated log volume (DLV). Contains a list of available options for a DB instance. This data type is used as a response element in the The database engine of the DB instance. Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> This data type is used as a response element in the The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth. Specifies whether to enable a dedicated log volume (DLV) for the DB instance. The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Specifies whether to enable a dedicated log volume (DLV) for the DB instance. The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth. Specifies whether to enable a dedicated log volume (DLV) for the DB instance. Valid processor features for your DB instance. Indicates whether a DB instance supports using a dedicated log volume (DLV). Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service. To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account. For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide. If you are copying a model version to a project in the same AWS account, you don't need to create a project policy. To copy a model, the destination project, source project, and source model version must already exist. Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service. To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account. For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide. If you are copying a model version to a project in the same AWS account, you don't need to create a project policy. Copying project versions is supported only for Custom Labels models. To copy a model, the destination project, source project, and source model version must already exist. Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of This operation requires permissions to perform the Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset. To create a training dataset for a project, specify The response from To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of Dataset creation fails if a terminal error occurs ( For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset. To create a training dataset for a project, specify The response from To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of Dataset creation fails if a terminal error occurs ( For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide. This operation requires permissions to perform the Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) that you use to create and manage Amazon Rekognition Custom Labels models. This operation requires permissions to perform the Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions) that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires permissions to perform the Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. The response from Training uses the training and test datasets associated with the project. For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide. You can train a model in a project that doesn't have associated datasets by specifying manifest files in the If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files. Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project. Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels developers guide. After evaluating the model, you start the model by calling StartProjectVersion. This operation requires permissions to perform the Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the This operation requires permissions to perform the The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature: You can train a model in a project that doesn't have associated datasets by specifying manifest files in the If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files. Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project. Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of You can't delete a dataset while it is creating ( This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of You can't delete a dataset while it is creating ( This operation requires permissions to perform the Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion. This operation requires permissions to perform the Deletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or adapter, see DeleteProjectVersion. This operation requires permissions to perform the Deletes an existing project policy. To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Deletes an existing project policy. To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy. This operation requires permissions to perform the Deletes an Amazon Rekognition Custom Labels model. You can't delete a model if it is running or if it is training. To check the status of a model, use the This operation requires permissions to perform the Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter. You can't delete a project version if it is running or if it is training. To check the status of a project version, use the Status field returned from DescribeProjectVersions. To stop a project version call StopProjectVersion. If the project version is training, wait until it finishes. This operation requires permissions to perform the Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset. This operation requires permissions to perform the Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in This operation requires permissions to perform the Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or adapter versions in This operation requires permissions to perform the Gets information about your Amazon Rekognition Custom Labels projects. This operation requires permissions to perform the Gets information about your Rekognition projects. This operation requires permissions to perform the Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. You specify which version of a model version to use by using the You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object that the model version detects on an image, the API returns a ( To filter labels that are returned, specify a value for If you don't specify a value for This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide. This operation applies only to Amazon Rekognition Custom Labels. Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. You specify which version of a model version to use by using the You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object that the model version detects on an image, the API returns a ( To filter labels that are returned, specify a value for If you don't specify a value for This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide. Detects unsafe content in a specified JPEG or PNG format image. Use To filter images, use the labels returned by For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. Detects unsafe content in a specified JPEG or PNG format image. Use To filter images, use the labels returned by For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. You can specify an adapter to use when retrieving label predictions by providing a Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset. Distributing a dataset takes a while to complete. To check the status call This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset. Distributing a dataset takes a while to complete. To check the status call This operation requires permissions to perform the Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file. JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file. JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date. This operation requires permissions to perform the Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images. Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide. This operation applies only to Amazon Rekognition Custom Labels. Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images. Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide. Gets a list of the project policies attached to a project. To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Gets a list of the project policies attached to a project. To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy. This operation requires permissions to perform the Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project policy specifies that a trusted AWS account can copy a model version from a trusting AWS account to a project in the trusted AWS account. To copy a model version you use the CopyProjectVersion operation. For more information about the format of a project policy document, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide. The response from To remove a project policy from a project, call DeleteProjectPolicy. To get a list of project policies attached to a project, call ListProjectPolicies. You copy a model version by calling CopyProjectVersion. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project policy specifies that a trusted AWS account can copy a model version from a trusting AWS account to a project in the trusted AWS account. To copy a model version you use the CopyProjectVersion operation. Only applies to Custom Labels projects. For more information about the format of a project policy document, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide. The response from To remove a project policy from a project, call DeleteProjectPolicy. To get a list of project policies attached to a project, call ListProjectPolicies. You copy a model version by calling CopyProjectVersion. This operation requires permissions to perform the Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions. Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels. You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion. For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions. Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels. You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion. This operation requires permissions to perform the Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. Only applies to Custom Labels projects. This operation requires permissions to perform the Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide. If the You specify the changes that you want to make in the To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of Dataset update fails if a terminal error occurs ( This operation requires permissions to perform the This operation applies only to Amazon Rekognition Custom Labels. Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide. If the You specify the changes that you want to make in the To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of Dataset update fails if a terminal error occurs ( This operation requires permissions to perform the The name of the project to create. Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default. Specifies whether automatic retraining should be attempted for the versions of the project. Automatic retraining is done as a best effort. Required argument for Content Moderation. Applicable only to adapters. The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train. The ARN of the Amazon Rekognition project that will manage the project version you want to train. A name for the version of the model. This value must be unique. A name for the version of the project version. This value must be unique. The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need Specifies an external manifest that the services uses to train the model. If you specify Specifies an external manifest that the services uses to train the project version. If you specify Specifies an external manifest that the service uses to test the model. If you specify Specifies an external manifest that the service uses to test the project version. If you specify A set of tags (key-value pairs) that you want to attach to the model. A set of tags (key-value pairs) that you want to attach to the project version. The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket ( If you choose to use your own KMS key, you need the following permissions on the KMS key. kms:CreateGrant kms:DescribeKey kms:GenerateDataKey kms:Decrypt If you don't specify a value for The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket ( If you choose to use your own KMS key, you need the following permissions on the KMS key. kms:CreateGrant kms:DescribeKey kms:GenerateDataKey kms:Decrypt If you don't specify a value for A description applied to the project version being created. Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned. The ARN of the model version that was created. Use The ARN of the model or the project version that was created. Use Configuration options for Custom Moderation training. Feature specific configuration for the training job. Configuration provided for the job must match the feature type parameter associated with project. If configuration and feature type do not match an InvalidParameterException is returned. The confidence level you plan to use to identify if unsafe content is present during inference. Configuration options for Content Moderation training. The Amazon Resource Name (ARN) of the model version that you want to delete. The Amazon Resource Name (ARN) of the project version that you want to delete. The Amazon Resource Name (ARN) of the project that contains the models you want to describe. The Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe. A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, A list of model or project version names that you want to describe. You can add up to 10 model or project version names to the list. If you don't specify a value, all project version descriptions are returned. A version name is part of a project version ARN. For example, If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest. A list of project version descriptions. The list is sorted by the creation date and time of the project versions, latest to earliest. If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account. A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account. Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default. If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. The ARN of the model version that you want to use. The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned. Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to. Identifier for the custom adapter. Expects the ProjectVersionArn as a value. Use the CreateProject or CreateProjectVersion APIs to create a custom adapter. Version number of the moderation detection model that was used to detect unsafe content. Version number of the base moderation detection model that was used to detect unsafe content. Shows the results of the human in the loop evaluation. Identifier of the custom adapter that was used during inference. If during inference the adapter was EXPIRED, then the parameter will not be returned, indicating that a base moderation detection project version was used. An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations ( An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: Information about the training and test datasets in the project. Specifies the project that is being customized. Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters. A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects. The Amazon Resource Name (ARN) of the model version. The Amazon Resource Name (ARN) of the project version. The minimum number of inference units used by the model. For more information, see StartProjectVersion. The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion. The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion. The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion. If the model version was copied from a different project, A user-provided description of the project version. The feature that was customized. The base detection model version used to create the project version. Feature specific configuration that was applied during training. A description of a version of an Amazon Rekognition Custom Labels model. A description of a version of a Amazon Rekognition project version. The minimum number of inference units to use. A single inference unit represents 1 hour of processing. For information about the number of transactions per second (TPS) that an inference unit can support, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use. The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use. The Amazon Resource Name (ARN) of the model version that you want to delete. This operation requires permissions to perform the The Amazon Resource Name (ARN) of the model version that you want to stop. This operation requires permissions to perform the If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size. If specified, Rekognition splits training dataset to create a test dataset for the training job. The dataset used for testing. Optionally, if The dataset used for testing. Optionally, if A Sagemaker GroundTruth manifest file that contains the training images (assets). A manifest file that contains references to the training images and ground-truth annotations. The dataset used for training. The training assets that you supplied for training. The training data that you supplied. The images (assets) that were actually trained by Amazon Rekognition Custom Labels. Reference to images (assets) that were actually used during training with trained model predictions. The location of the data validation manifest. The data validation manifest is created for the training dataset during model training. A manifest that you supplied for training, with validation results for each line. Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing. The data validation manifest created for the training dataset during model training. Contains the Amazon S3 bucket location of the validation data for a model training job. The validation data includes error information for individual JSON Lines in the dataset. For more information, see Debugging a Failed Model Training in the Amazon Rekognition Custom Labels Developer Guide. You get the The assets array contains a single Asset object. The GroundTruthManifest field of the Asset object contains the S3 bucket location of the validation data. Create a new The You must include at least one of Create a new The Note that it can take approximately 10-15 minutes to provision an You must include at least one of Delete the Data written into the Delete the Data written into the Note that it can take approximately 10-15 minutes to delete an Time series forecast settings for the Canvas application. Time series forecast settings for the SageMaker Canvas application. The settings for connecting to an external data source with OAuth. The settings for document querying. The model deployment settings for the SageMaker Canvas application. The SageMaker Canvas application settings. Describes whether model deployment permissions are enabled or disabled in the Canvas application. The model deployment settings for the SageMaker Canvas application. In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM execution role must have the The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL. The Amazon SageMaker Canvas app setting where you configure OAuth for connecting to an external data source, such as Snowflake. The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake. Describes whether the document querying feature is enabled or disabled in the Canvas application. The Amazon SageMaker Canvas application setting where you configure document querying. The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either This field is required if the steps you specify for Analyzes identity documents for relevant information. This information is extracted and returned as Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags. Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID. Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion. Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. Each document page has as an associated For more information, see Document Text Detection. Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes. Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics. Gets summarized results for the You start asynchronous text analysis by calling To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call List all version of an adapter that meet the specified filtration criteria. Lists all adapters that match the specified filtration criteria. Lists all tags for an Amazon Textract resource. Starts the classification and analysis of an input document. If using detailedResponse (contains the GetLendingAnalysis response) summaryResponse (for the GetLendingAnalysisSummary response) splitDocuments (documents split across logical boundaries) Adds one or more tags to the specified resource. Removes any tags with the specified keys from the specified resource. Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument. You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. A unique identifier for the adapter resource. Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter. If a page is not specified, it is set to The following characters are allowed in the parameter's string: When using * to indicate all pages, it must be the only element in the list. You can use page intervals, such as Specified pages must be greater than 0 and less than or equal to the number of pages in the document. A string that identifies the version of the adapter. An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously. A unique identifier for the adapter resource. A string naming the adapter resource. The date and time that the adapter was created. The feature types that the adapter is operating on. Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types. The dataset configuration options for a given version of an adapter. Can include an Amazon S3 bucket if specified. The F1 score, precision, and recall metrics for the baseline model. The F1 score, precision, and recall metrics for the baseline model. Indicates the feature type being analyzed by a given adapter version. Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance. A unique identifier for the adapter associated with a given adapter version. An identified for a given adapter version. The date and time that a given adapter version was created. The feature types that the adapter version is operating on. Contains information on the status of a given adapter version. A message explaining the status of a given adapter vesion. Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status. A list of adapters to be used when analyzing the specified document. Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. To perform both forms and table analysis, add TABLES and FORMS to A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of Contains Queries and the alias for those Queries, as determined by the input. Specifies the adapter to be used when analyzing a document. The type of text item that's recognized. In operations for text detection, the following types are returned: PAGE - Contains a list of the LINE WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: PAGE - Contains a list of child KEY_VALUE_SET - Stores the KEY and VALUE WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page. TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each. TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table. TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table. CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell. MERGED_CELL - A cell in a table whose content spans more than one row or column. The SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell. QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer. QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score. The type of text item that's recognized. In operations for text detection, the following types are returned: PAGE - Contains a list of the LINE WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: PAGE - Contains a list of child KEY_VALUE_SET - Stores the KEY and VALUE WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page. TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each. TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table. TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table. CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell. MERGED_CELL - A cell in a table whose content spans more than one row or column. The SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell. QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer. QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score. The following BlockTypes are only returned for Amazon Textract Layout. Updating or deleting a resource can cause an inconsistent state. The name to be assigned to the adapter being created. Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times. The description to be assigned to the adapter being created. The type of feature that the adapter is being trained on. Currrenly, supported feature types are: Controls whether or not the adapter should automatically update. A list of tags to be added to the adapter. A string containing the unique ID for the adapter that has been created. A string containing a unique ID for the adapter that will receive a new version. Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times. Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value. The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents. A set of tags (key-value pairs) that you want to attach to the adapter version. A string containing the unique ID for the adapter that has received a new version. A string describing the new version of the adapter. A string containing a unique ID for the adapter to be deleted. A string containing a unique ID for the adapter version that will be deleted. Specifies the adapter version to be deleted. The F1 score for an adapter version. The Precision score for an adapter version. The Recall score for an adapter version. The evaluation metrics (F1 score, Precision, and Recall) for an adapter version. Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. A string containing a unique ID for the adapter. A string identifying the adapter that information has been retrieved for. The name of the requested adapter. The date and time the requested adapter was created at. The description for the requested adapter. List of the targeted feature types for the requested adapter. Binary value indicating if the adapter is being automatically updated or not. A set of tags (key-value pairs) associated with the adapter that has been retrieved. A string specifying a unique ID for the adapter version you want to retrieve information for. A string specifying the adapter version you want to retrieve information for. A string containing a unique ID for the adapter version being retrieved. A string containing the adapter version that has been retrieved. The time that the adapter version was created. List of the targeted feature types for the requested adapter version. The status of the adapter version that has been requested. A message that describes the status of the requested adapter version. Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value. The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents. The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version. A set of tags (key-value pairs) that are associated with the adapter version. A string containing a unique ID for the adapter to match for when listing adapter versions. Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time. Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time. The maximum number of results to return when listing adapter versions. Identifies the next page of results to return when listing adapter versions. Adapter versions that match the filtering criteria specified when calling ListAdapters. Identifies the next page of results to return when listing adapter versions. Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time. Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time. The maximum number of results to return when listing adapters. Identifies the next page of results to return when listing adapters. A list of adapters that matches the filtering criteria specified when calling ListAdapters. Identifies the next page of results to return when listing adapters. The Amazon Resource Name (ARN) that specifies the resource to list tags for. A set of tags (key-value pairs) that are part of the requested resource. Returned when an operation tried to access a nonexistent resource. Returned when a request cannot be completed as it would exceed a maximum service quota. The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3. Specifies the adapter to be used when analyzing a document. The Amazon Resource Name (ARN) that specifies the resource to be tagged. A set of tags (key-value pairs) that you want to assign to the resource. The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. The Amazon Resource Name (ARN) that specifies the resource to be untagged. Specifies the tags to be removed from the resource specified by the ResourceARN. A string containing a unique ID for the adapter that will be updated. The new description to be applied to the adapter. The new name to be applied to the adapter. The new auto-update status to be applied to the adapter. A string containing a unique ID for the adapter that has been updated. A string containing the name of the adapter that has been updated. An object specifying the creation time of the the adapter that has been updated. A string containing the description of the adapter that has been updated. List of the targeted feature types for the updated adapter. The auto-update status of the adapter that has been updated. Indicates that a request was not valid. Check request for proper formatting. Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. The Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. The PCoIP is only available for Windows bundles.
"
},
"NotificationMetadata":{
- "shape":"XmlStringMaxLen1023",
+ "shape":"AnyPrintableAsciiStringMaxLen4000",
"documentation":"autoscaling:EC2_INSTANCE_LAUNCHING.autoscaling:EC2_INSTANCE_TERMINATING.\"Event\": \"autoscaling:TEST_NOTIFICATION\".ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period. limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.limit. In such cases, you can make another call, using the nextToken.AWS::Config::ResourceCompliance resource type. For more information, see Selecting Which Resources Config Records.ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period. limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.limit. In such cases, you can make another call, using the nextToken.
"
},
"configurationStateId":{
"shape":"ConfigurationStateId",
@@ -2348,7 +2348,7 @@
},
"configurationItemStatus":{
"shape":"ConfigurationItemStatus",
- "documentation":"
"
},
"configurationStateId":{
"shape":"ConfigurationStateId",
@@ -4039,7 +4039,7 @@
"documentation":"resourceTypes field to enter a comma-separated list of resource types to exclude as exemptions.resourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled. IAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022. This list does not include the following Regions:
s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack. s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack. true, when Config adds support for a new type of regional resource, Config starts recording resources of that type automatically.true, you cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.true, when Config adds support for a new regionally recorded resource type, Config starts recording resources of that type automatically.true, you cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.true, set the allSupported field of RecordingGroup to true. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.true, when Config adds support for a new type of global resource in the Region where you set up the configuration recorder, Config starts recording resources of that type automatically.false but list global resource types in the resourceTypes field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.
AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is not set to true. includeGlobalResourceTypes is a legacy field which only applies to IAM users, groups, roles, and customer managed policies. AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:
EXCLUSION_BY_RESOURCE_TYPES), orINCLUSION_BY_RESOURCE_TYPES).true, set the allSupported field of RecordingGroup to true. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.false but list globally recorded IAM resource types in the resourceTypes field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.
useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported regional resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type.useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types you specify in the resourceTypes field of RecordingGroup.useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types except the resource types that you specify as exemptions to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.includeGlobalResourceTypes to false, global resource types will still be automatically recorded in this option unless those resource types are specifically listed as exemptions in the resourceTypes field of exclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.
useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported regionally recorded resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type.useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types you specify in the resourceTypes field of RecordingGroup.useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.includeGlobalResourceTypes to false, globally recorded IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled. IAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022. This list does not include the following Regions:
resourceTypes parameter.
EXCLUSION_BY_RESOURCE_TYPES), orINCLUSION_BY_RESOURCE_TYPES).AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled.AWS::RDS::GlobalCluster in all enabled Regions, use the EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_BY_RESOURCE_TYPES recording strategy.
ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported regional resource types. You also must set the allSupported field of RecordingGroup to true.INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types that you specify in the resourceTypes field of RecordingGroup.EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types, except the resource types that you specify as exemptions to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.includeGlobalResourceTypes to false, global resource types will still be automatically recorded in this option unless those resource types are specifically listed as exemptions in the resourceTypes field of exclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.
ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported regionally recorded resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide.INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types that you specify in the resourceTypes field of RecordingGroup.EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.includeGlobalResourceTypes to false, globally recorded IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled. IAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022. This list does not include the following Regions:
EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days.EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the AWS Control Tower User Guide
"
},
"ListEnabledControls":{
"name":"ListEnabledControls",
@@ -86,7 +104,7 @@
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"}
],
- "documentation":"controlIdentifier, see the overview page.targetIdentifier, see the overview page.
"
+ }
+ },
+ "documentation":"DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that AWS Control Tower expected. IN_SYNC: The enabledControl deployed in this configuration matches the configuration that AWS Control Tower expected.NOT_CHECKING: AWS Control Tower does not check drift for this enabled control. Drift is not supported for the control type.UNKNOWN: AWS Control Tower is not able to check the drift status for the enabled control. controlIdentifier, see the overview page.targetIdentifier, see the overview page.controlIdentifier, see the overview page. targetIdentifier, see the overview page. controlIdentifier, see the overview page.
"
+ }
+ },
+ "documentation":"SUCCEEDED: The enabledControl configuration was deployed successfully.UNDER_CHANGE: The enabledControl configuration is changing. FAILED: The enabledControl configuration failed to deploy.targetIdentifier, see the overview page.
ControlARN for the control--that is, the guardrail--you are targeting,ControlARN for your AWS Control Tower guardrail: ControlARN contains the control name which is specified in each guardrail. For a list of control names for Strongly recommended and Elective guardrails, see Resource identifiers for APIs and guardrails in the Automating tasks section of the AWS Control Tower User Guide. Remember that Mandatory guardrails cannot be added or removed.arn:aws:controltower:{REGION}::control/{CONTROL_NAME} arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
controlIdentifier for the control--or guardrail--you are targeting.targetIdentifier.controlIdentifier for your AWS Control Tower control: controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.controlIdentifier is unique in each AWS Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata in the AWS Control Tower User Guide. arn:aws:controltower:{REGION}::control/{CONTROL_NAME} arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED targetIdentifier: targetIdentifier is the ARN for an OU.arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId} disabled and removes all launch permissions from the AMI. A disabled AMI can't be used for instance launches.enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.available and can be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services accounts, organizations, and Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once the AMI is available, it can be shared with them again.
",
+ "documentation":"architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.description - The description of the image (provided during image creation).ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.hypervisor - The hypervisor type (ovm | xen).image-id - The ID of the image.image-type - The image type (machine | kernel | ramdisk).is-public - A Boolean that indicates whether the image is public.kernel-id - The kernel ID.manifest-location - The location of the image manifest.name - The name of the AMI (provided during image creation).owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.platform - The platform. The only supported value is windows.product-code - The product code.product-code.type - The type of the product code (marketplace).ramdisk-id - The RAM disk ID.root-device-name - The device name of the root device volume (for example, /dev/sda1).root-device-type - The type of the root device volume (ebs | instance-store).state - The state of the image (available | pending | failed).state-reason-code - The reason code for the state change.state-reason-message - The message for the state change.sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.virtualization-type - The virtualization type (paravirtual | hvm).
",
"locationName":"Filter"
},
"ImageIds":{
@@ -19983,6 +20004,10 @@
"shape":"Boolean",
"documentation":"architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.description - The description of the image (provided during image creation).ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.hypervisor - The hypervisor type (ovm | xen).image-id - The ID of the image.image-type - The image type (machine | kernel | ramdisk).is-public - A Boolean that indicates whether the image is public.kernel-id - The kernel ID.manifest-location - The location of the image manifest.name - The name of the AMI (provided during image creation).owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.platform - The platform. The only supported value is windows.product-code - The product code.product-code.type - The type of the product code (marketplace).ramdisk-id - The RAM disk ID.root-device-name - The device name of the root device volume (for example, /dev/sda1).root-device-type - The type of the root device volume (ebs | instance-store).source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage.state - The state of the image (available | pending | failed).state-reason-code - The reason code for the state change.state-reason-message - The message for the state change.sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.virtualization-type - The virtualization type (paravirtual | hvm).DryRunOperation. Otherwise, it is UnauthorizedOperation.
",
+ "documentation":"task-state - Returns tasks in a certain state (InProgress | Completed | Failed)bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
task-state - Returns tasks in a certain state (InProgress | Completed | Failed)bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.ImageIds parameter, any filters that you specify are ignored. To use the filters, you must remove the ImageIds parameter.ImageIDs parameter in the same call.ImageIds parameter in the same call.DryRunOperation. Otherwise, it is UnauthorizedOperation.true if the request succeeds; otherwise, it returns an error.DryRunOperation. Otherwise, it is UnauthorizedOperation.true if the request succeeds; otherwise, it returns an error.xen is supported. ovm is not supported.v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.
"
+ "documentation":"idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false.routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false.routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.
"
},
"Value":{
"shape":"LoadBalancerAttributeValue",
@@ -2845,15 +2845,15 @@
},
"Subnets":{
"shape":"Subnets",
- "documentation":"dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity.ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).RepositoryName should include WorkspaceName. Use the format <WorkspaceName>/<RepositoryName>. RepositoryName should include WorkspaceName. Use the format <WorkspaceName>/<RepositoryName>. SUPPRESS this action creates a suppression rule.ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.resource value determines the valid values for type in your request. For more information, see Finding types in the Amazon Inspector user guide.UNTRIAGED applies to PACKAGE_VULNERABILITY type findings that the vendor has not assigned a severity yet. For more information, see Severity levels for findings in the Amazon Inspector user guide.type value determines the valid values for resource in your request. For more information, see Finding types in the Amazon Inspector user guide.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.nextToken value, use this value when you call the action again to get the remaining results.NextToken value returned from the previous request to continue listing results after the first page.maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance. UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.SUCCESSFUL - The scan was successful.NO_RESOURCES_FOUND - Reserved for future use.IMAGE_SIZE_EXCEEDED - Reserved for future use.SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not new findings because of the scan frequency configuration.EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it’s in a stopped state.PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.NO INVENTORY - Amazon Inspector couldn’t find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance’s inventory in the SSM Fleet Manager console.STALE_INVENTORY - Amazon Inspector wasn’t able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media type.UNSUPPORTED_CONFIG_FILE - Reserved for future use.DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.DEEP_INSPECTION_NO_INVENTORY The Amazon Inspector plugin hasn't yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.RHEL, AMAZON_CVE, DEBIAN or NVD.SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.TagResource operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. RDSSelectQuery query.RedshiftSelectSqlQuery query. The password should be valid for an Amazon Redshift USER.PriceListArn and FileFormat that you retrieve from the ListPriceLists response. PriceListArn and FileFormat that you retrieve from the ListPriceLists response. ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.PriceListArn can be obtained from the ListPriceLists response. PriceListArn can be obtained from the ListPriceLists response. FileFormat can be obtained from the ListPriceLists response. FileFormat can be obtained from the ListPriceLists response. AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.ComputeSavingsPlans. To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans. AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.ComputeSavingsPlans. MachineLearningSavingsPlans. US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
"
+ "documentation":"Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.RDSCDB. The Oracle SID is also the name of your CDB.
"
+ },
+ "DedicatedLogVolume":{
+ "shape":"BooleanOptional",
+ "documentation":"SourceDBInstanceIdentifier parameter is also specified.CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.DescribeDBSnapshots action.
oracle-ee-cdb or oracle-se2-cdb.
"
+ },
+ "DedicatedLogVolume":{
+ "shape":"BooleanOptional",
+ "documentation":"--db-parameter-group-name and a new option group with --option-group-name.DescribeOrderableDBInstanceOptions action.ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.CreateDBInstance.DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED.rekognition:CopyProjectVersion action.Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED.rekognition:CopyProjectVersion action.TRAIN for the value of DatasetType. To create the test dataset for a project, specify TEST for the value of DatasetType. CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE. errors lists in the JSON Lines.Status = CREATE_FAILED). Currently, you can't access the terminal error information. rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.TRAIN for the value of DatasetType. To create the test dataset for a project, specify TEST for the value of DatasetType. CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE. errors lists in the JSON Lines.Status = CREATE_FAILED). Currently, you can't access the terminal error information. rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.rekognition:CreateProject action.rekognition:CreateProject action.CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model. TrainingData and TestingData fields. Status field is TRAINING_COMPLETED.rekognition:CreateProjectVersion action.CreateProjectVersion is an Amazon Resource Name (ARN) for the project version. Status field is TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.rekognition:CreateProjectVersion action.TrainingData and TestingData fields. Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception. Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).rekognition:DeleteDataset action.Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception. Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).rekognition:DeleteDataset action.DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with that project.rekognition:DeleteProject action. DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with that project.rekognition:DeleteProject action. rekognition:DeleteProjectPolicy action.rekognition:DeleteProjectPolicy action.Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. If the model is training, wait until it finishes.rekognition:DeleteProjectVersion action. rekognition:DeleteProjectVersion action. rekognition:DescribeDataset action.rekognition:DescribeDataset action.ProjectVersionArns. If you don't specify a value, descriptions for all model versions in the project are returned.rekognition:DescribeProjectVersions action.ProjectVersionArns. If you don't specify a value, descriptions for all model/adapter versions in the project are returned.rekognition:DescribeProjectVersions action.rekognition:DescribeProjects action.rekognition:DescribeProjects action.ProjectVersionArn input parameter. CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry). MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide. MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.rekognition:DetectCustomLabels action. ProjectVersionArn input parameter. CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry). MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide. MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.rekognition:DetectCustomLabels action. DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.DetectModerationLabels to determine which types of content are appropriate.DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.DetectModerationLabels to determine which types of content are appropriate.ProjectVersionArn to the ProjectVersion argument.DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image. DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.rekognition:DistributeDatasetEntries action.DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image. DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.rekognition:DistributeDatasetEntries action.errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training. rekognition:ListDatasetEntries action.errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training. rekognition:ListDatasetEntries action.rekognition:ListProjectPolicies action.rekognition:ListProjectPolicies action.PutProjectPolicy is a revision ID for the project policy. You can attach multiple project policies to a project. You can also update an existing project policy by specifying the policy revision ID of the existing policy.rekognition:PutProjectPolicy action.PutProjectPolicy is a revision ID for the project policy. You can attach multiple project policies to a project. You can also update an existing project policy by specifying the policy revision ID of the existing policy.rekognition:PutProjectPolicy action.rekognition:StartProjectVersion action.rekognition:StartProjectVersion action.rekognition:StopProjectVersion action.rekognition:StopProjectVersion action.source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset. Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE. errors lists in the JSON Lines.Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK. rekognition:UpdateDatasetEntries action.source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset. Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE. errors lists in the JSON Lines.Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK. rekognition:UpdateDatasetEntries action.s3:PutObject permissions on the S3 bucket.s3:PutObject permission on the bucket. TrainingData you must also specify TestingData. The project must not have any associated datasets. TrainingData you must also specify TestingData. The project must not have any associated datasets. TestingData you must also specify TrainingData. The project must not have any associated datasets.TestingData you must also specify TrainingData. The project must not have any associated datasets.OutputConfig).
KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.OutputConfig).
KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.DescribeProjectVersion to get the current status of the training operation.DescribeProjectVersion to get the current status of the training operation.my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit. StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit. SourceProjectVersionArn contains the ARN of the source model version. rekognition:StopProjectVersion action.rekognition:StopProjectVersion action.AutoCreate is set, Amazon Rekognition Custom Labels uses the training dataset to create a test dataset with a temporary split of the training dataset. AutoCreate is set, Amazon Rekognition uses the training dataset to create a test dataset with a temporary split of the training dataset. ValidationData object for the training dataset (TrainingDataResult) and the test dataset (TestingDataResult) by calling DescribeProjectVersions. FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record. FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record. FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.OnlineStore FeatureGroup with the InMemory StorageType.OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called. OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted. FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called. OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted. OnlineStore FeatureGroup with the InMemory StorageType.AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.Failed or Success.Failed or Success.SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.DetectDocumentText returns the detected text in an array of Block objects. Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document. StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis. GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document. StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:
"
+ },
+ "TagResource":{
+ "name":"TagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"TagResourceRequest"},
+ "output":{"shape":"TagResourceResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InvalidParameterException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ProvisionedThroughputExceededException"},
+ {"shape":"InternalServerError"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ValidationException"}
+ ],
+ "documentation":"
"
+ },
+ "Version":{
+ "shape":"AdapterVersion",
+ "documentation":"[\"1\"] by default.0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.[\"1-3\", \"1-1\", \"4-*\"]. Where * indicates last page of document.FeatureTypes. To detect signatures within the document and within form data and table data, add SIGNATURES to either TABLES or FORMS. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes). FeatureTypes).
Block objects that are detected on a document page.
"
+ "documentation":"Block objects that are detected on a document page.Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object. Relationships array for this cell contain data from individual cells.SelectionStatus to determine the status of the selection element.
Block objects that are detected on a document page.
Block objects that are detected on a document page.Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object. Relationships array for this cell contain data from individual cells.SelectionStatus to determine the status of the selection element.
"
},
"Confidence":{
"shape":"Percent",
@@ -542,6 +979,13 @@
"min":1,
"pattern":"^[a-zA-Z0-9-_]+$"
},
+ "ConflictException":{
+ "type":"structure",
+ "members":{
+ },
+ "documentation":"LAYOUT_TITLE - The main title of the document.LAYOUT_HEADER - Text located in the top margin of the document.LAYOUT_FOOTER - Text located in the bottom margin of the document.LAYOUT_SECTION_HEADER - The titles of sections within a document.LAYOUT_PAGE_NUMBER - The page number of the documents.LAYOUT_LIST - Any information grouped together in list form. LAYOUT_FIGURE - Indicates the location of an image in a document.LAYOUT_TABLE - Indicates the location of a table in the document.LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.QUERIES MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.