Eckard Mühlich
💻
* Payloads are still signed for requests over HTTP to preserve the request
* integrity over a non-secure transport.
+ *
+ * @deprecated Use {@code software.amazon.awssdk.http.auth.aws.signer.AwsV4HttpSigner} from the 'http-auth-aws' module.
*/
@SdkPublicApi
+@Deprecated
public final class Aws4UnsignedPayloadSigner extends BaseAws4Signer {
public static final String UNSIGNED_PAYLOAD = "UNSIGNED-PAYLOAD";
diff --git a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/AwsS3V4Signer.java b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/AwsS3V4Signer.java
index eb0a93c123f4..9df0b58b9302 100644
--- a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/AwsS3V4Signer.java
+++ b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/AwsS3V4Signer.java
@@ -20,7 +20,10 @@
/**
* AWS4 signer implementation for AWS S3
+ *
+ * @deprecated Use {@code software.amazon.awssdk.http.auth.aws.signer.AwsV4HttpSigner} from the 'http-auth-aws' module.
*/
+@Deprecated
@SdkPublicApi
public final class AwsS3V4Signer extends AbstractAwsS3V4Signer {
private AwsS3V4Signer() {
diff --git a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/EventStreamAws4Signer.java b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/EventStreamAws4Signer.java
index 474046cf2202..8776f4b5dc0b 100644
--- a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/EventStreamAws4Signer.java
+++ b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/EventStreamAws4Signer.java
@@ -18,6 +18,7 @@
import software.amazon.awssdk.annotations.SdkProtectedApi;
import software.amazon.awssdk.auth.signer.internal.BaseEventStreamAsyncAws4Signer;
+@Deprecated
@SdkProtectedApi
public final class EventStreamAws4Signer extends BaseEventStreamAsyncAws4Signer {
private EventStreamAws4Signer() {
diff --git a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/SignerLoader.java b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/SignerLoader.java
index add5a3e83208..94781f69b90f 100644
--- a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/SignerLoader.java
+++ b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/SignerLoader.java
@@ -26,6 +26,7 @@
/**
* Utility class for instantiating signers only if they're available on the class path.
*/
+@Deprecated
@SdkProtectedApi
public final class SignerLoader {
diff --git a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/BaseAws4Signer.java b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/BaseAws4Signer.java
index 6ae237487578..08652ec79134 100644
--- a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/BaseAws4Signer.java
+++ b/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/BaseAws4Signer.java
@@ -27,6 +27,7 @@
* Abstract base class for concrete implementations of Aws4 signers.
*/
@SdkInternalApi
+@Deprecated
public abstract class BaseAws4Signer extends AbstractAws4Signer
+ * Note: S3 requires this value to be set to 'false' to prevent signature mismatch errors for certain paths.
*/
SignerProperty
+ * Note: S3 requires this value to be set to 'false' to prevent signature mismatch errors for certain paths.
*/
SignerProperty
+ * When this value is true and {@link #CHUNK_ENCODING_ENABLED} is false, the whole payload must be read to generate
+ * the payload signature. For very large payloads, this could impact memory usage and call latency. Some services
+ * support this value being disabled, especially over HTTPS where SSL provides some of its own protections against
+ * payload tampering.
*/
SignerProperty
+ * Only some services support this value being set to true, but for those services it can prevent the need to read
+ * the whole payload before writing when {@link #PAYLOAD_SIGNING_ENABLED} is true.
*/
SignerProperty
- * The process for signing requests to send to AWS services is documented
+ * The steps performed by this signer are documented
* here.
+ *
+ *
+ * Sign an HTTP request and send it to a service.
+ *
+ * {@snippet :
+ * AwsV4HttpSigner signer = AwsV4HttpSigner.create();
+ *
+ * // Specify AWS credentials. Credential providers that are used by the SDK by default are
+ * // available in the module "auth" (e.g. DefaultCredentialsProvider).
+ * AwsCredentialsIdentity credentials =
+ * AwsSessionCredentialsIdentity.create("skid", "akid", "stok");
+ *
+ * // Create the HTTP request to be signed
+ * SdkHttpRequest httpRequest =
+ * SdkHttpRequest.builder()
+ * .uri("https://s3.us-west-2.amazonaws.com/bucket/object")
+ * .method(SdkHttpMethod.PUT)
+ * .putHeader("Content-Type", "text/plain")
+ * .build();
+ *
+ * // Create the request payload to be signed
+ * ContentStreamProvider requestPayload =
+ * ContentStreamProvider.fromUtf8String("Hello, World!");
+ *
+ * // Sign the request. Some services require custom signing configuration properties (e.g. S3).
+ * // See AwsV4HttpSigner and AwsV4FamilyHttpSigner for the available signing options.
+ * // Note: The S3Client class below requires a dependency on the 's3' module. Alternatively, the
+ * // signing name can be hard-coded because it is guaranteed to not change.
+ * SignedRequest signedRequest =
+ * signer.sign(r -> r.identity(credentials)
+ * .request(httpRequest)
+ * .payload(requestPayload)
+ * .putProperty(AwsV4HttpSigner.SERVICE_SIGNING_NAME, S3Client.SERVICE_NAME)
+ * .putProperty(AwsV4HttpSigner.REGION_NAME, "us-west-2")
+ * .putProperty(AwsV4HttpSigner.DOUBLE_URL_ENCODE, false) // Required for S3 only
+ * .putProperty(AwsV4HttpSigner.NORMALIZE_PATH, false)); // Required for S3 only
+ *
+ * // Create and HTTP client and send the request. ApacheHttpClient requires the 'apache-client' module.
+ * try (SdkHttpClient httpClient = ApacheHttpClient.create()) {
+ * HttpExecuteRequest httpExecuteRequest =
+ * HttpExecuteRequest.builder()
+ * .request(signedRequest.request())
+ * .contentStreamProvider(signedRequest.payload().orElse(null))
+ * .build();
+ *
+ * HttpExecuteResponse httpResponse =
+ * httpClient.prepareRequest(httpExecuteRequest).call();
+ *
+ * System.out.println("HTTP Status Code: " + httpResponse.httpResponse().statusCode());
+ * } catch (IOException e) {
+ * System.err.println("HTTP Request Failed.");
+ * e.printStackTrace();
+ * }
+ * }
*/
@SdkPublicApi
public interface AwsV4HttpSigner extends AwsV4FamilyHttpSigner
- * The process for signing requests to send to AWS services is documented
+ * AWS request signing is described
* here.
+ *
+ *
+ * Sign an HTTP request and send it to a service.
+ *
+ * {@snippet :
+ * AwsV4aHttpSigner signer = AwsV4aHttpSigner.create();
+ *
+ * // Specify AWS credentials. Credential providers that are used by the SDK by default are
+ * // available in the module "auth" (e.g. DefaultCredentialsProvider).
+ * AwsCredentialsIdentity credentials =
+ * AwsSessionCredentialsIdentity.create("skid", "akid", "stok");
+ *
+ * // Create the HTTP request to be signed
+ * SdkHttpRequest httpRequest =
+ * SdkHttpRequest.builder()
+ * .uri("https://s3.us-west-2.amazonaws.com/bucket/object")
+ * .method(SdkHttpMethod.PUT)
+ * .putHeader("Content-Type", "text/plain")
+ * .build();
+ *
+ * // Create the request payload to be signed
+ * ContentStreamProvider requestPayload =
+ * ContentStreamProvider.fromUtf8String("Hello, World!");
+ *
+ * // Sign the request. Some services require custom signing configuration properties (e.g. S3).
+ * // See AwsV4aHttpSigner and AwsV4FamilyHttpSigner for the available signing options.
+ * // Note: The S3Client class below requires a dependency on the 's3' module. Alternatively, the
+ * // signing name can be hard-coded because it is guaranteed to not change.
+ * SignedRequest signedRequest =
+ * signer.sign(r -> r.identity(credentials)
+ * .request(httpRequest)
+ * .payload(requestPayload)
+ * .putProperty(AwsV4aHttpSigner.SERVICE_SIGNING_NAME, S3Client.SERVICE_NAME)
+ * .putProperty(AwsV4aHttpSigner.REGION_SET, RegionSet.create("us-west-2"))
+ * .putProperty(AwsV4aHttpSigner.DOUBLE_URL_ENCODE, false) // Required for S3 only
+ * .putProperty(AwsV4aHttpSigner.NORMALIZE_PATH, false)); // Required for S3 only
+ *
+ * // Create and HTTP client and send the request. ApacheHttpClient requires the 'apache-client' module.
+ * try (SdkHttpClient httpClient = ApacheHttpClient.create()) {
+ * HttpExecuteRequest httpExecuteRequest =
+ * HttpExecuteRequest.builder()
+ * .request(signedRequest.request())
+ * .contentStreamProvider(signedRequest.payload().orElse(null))
+ * .build();
+ *
+ * HttpExecuteResponse httpResponse =
+ * httpClient.prepareRequest(httpExecuteRequest).call();
+ *
+ * System.out.println("HTTP Status Code: " + httpResponse.httpResponse().statusCode());
+ * } catch (IOException e) {
+ * System.err.println("HTTP Request Failed.");
+ * e.printStackTrace();
+ * }
+ * }
*/
@SdkPublicApi
public interface AwsV4aHttpSigner extends AwsV4FamilyHttpSigner By default, it will time out if streaming hasn't started within 10 seconds, and use application/octet-stream as
+ * content type. You can configure it via {@link BlockingInputStreamAsyncRequestBody#builder()}
* Example Usage
*
*
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingInputStreamAsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingInputStreamAsyncRequestBody.java
index 9210f3bb5e41..3639d82c04c1 100644
--- a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingInputStreamAsyncRequestBody.java
+++ b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingInputStreamAsyncRequestBody.java
@@ -26,6 +26,7 @@
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.core.exception.NonRetryableException;
import software.amazon.awssdk.core.internal.io.SdkLengthAwareInputStream;
+import software.amazon.awssdk.core.internal.util.Mimetype;
import software.amazon.awssdk.core.internal.util.NoopSubscription;
import software.amazon.awssdk.utils.Validate;
import software.amazon.awssdk.utils.async.InputStreamConsumingPublisher;
@@ -39,14 +40,17 @@
@SdkPublicApi
public final class BlockingInputStreamAsyncRequestBody implements AsyncRequestBody {
private static final Duration DEFAULT_SUBSCRIBE_TIMEOUT = Duration.ofSeconds(10);
+ private static final String DEFAULT_CONTENT_TYPE = Mimetype.MIMETYPE_OCTET_STREAM;
private final InputStreamConsumingPublisher delegate = new InputStreamConsumingPublisher();
private final CountDownLatch subscribedLatch = new CountDownLatch(1);
private final AtomicBoolean subscribeCalled = new AtomicBoolean(false);
private final Long contentLength;
+ private final String contentType;
private final Duration subscribeTimeout;
BlockingInputStreamAsyncRequestBody(Builder builder) {
this.contentLength = builder.contentLength;
+ this.contentType = builder.contentType != null ? builder.contentType : DEFAULT_CONTENT_TYPE;
this.subscribeTimeout = Validate.isPositiveOrNull(builder.subscribeTimeout, "subscribeTimeout") != null ?
builder.subscribeTimeout :
DEFAULT_SUBSCRIBE_TIMEOUT;
@@ -64,6 +68,11 @@ public Optional
- * Each call to to the {@link #newStream()} method must result in a stream whose position is at the beginning of the content.
+ * Each call to the {@link #newStream()} method must result in a stream whose position is at the beginning of the content.
* Implementations may return a new stream or the same stream for each call. If returning a new stream, the implementation
* must ensure to {@code close()} and free any resources acquired by the previous stream. The last stream returned by {@link
* #newStream()}} will be closed by the SDK.
- *
*/
@SdkPublicApi
@FunctionalInterface
public interface ContentStreamProvider {
+ /**
+ * Create {@link ContentStreamProvider} from a byte array. This will copy the contents of the byte array.
+ */
+ static ContentStreamProvider fromByteArray(byte[] bytes) {
+ Validate.paramNotNull(bytes, "bytes");
+ byte[] copy = Arrays.copyOf(bytes, bytes.length);
+ return () -> new ByteArrayInputStream(copy);
+ }
+
+ /**
+ * Create {@link ContentStreamProvider} from a byte array without copying the contents of the byte array.
+ * This introduces concurrency risks, allowing the caller to modify the byte array stored in this
+ * {@code ContentStreamProvider} implementation.
+ *
+ * As the method name implies, this is unsafe. Use {@link #fromByteArray(byte[])} unless you're sure you know
+ * the risks.
+ */
+ static ContentStreamProvider fromByteArrayUnsafe(byte[] bytes) {
+ Validate.paramNotNull(bytes, "bytes");
+ return () -> new ByteArrayInputStream(bytes);
+ }
+
+ /**
+ * Create {@link ContentStreamProvider} from a string, using the provided charset.
+ */
+ static ContentStreamProvider fromString(String string, Charset charset) {
+ Validate.paramNotNull(string, "string");
+ Validate.paramNotNull(charset, "charset");
+ return () -> new StringInputStream(string, charset);
+ }
+
+ /**
+ * Create {@link ContentStreamProvider} from a string, using the UTF-8 charset.
+ */
+ static ContentStreamProvider fromUtf8String(String string) {
+ return fromString(string, StandardCharsets.UTF_8);
+ }
+
+ /**
+ * Create a {@link ContentStreamProvider} from an input stream.
+ *
+ * If the provided input stream supports mark/reset, the stream will be marked with a 128Kb read limit and reset
+ * each time {@link #newStream()} is invoked. If the provided input stream does not support mark/reset,
+ * {@link #newStream()} will return the provided stream once, but fail subsequent calls. To create new streams when
+ * needed instead of using mark/reset, see {@link #fromInputStreamSupplier(Supplier)}.
+ */
+ static ContentStreamProvider fromInputStream(InputStream inputStream) {
+ Validate.paramNotNull(inputStream, "inputStream");
+ IoUtils.markStreamWithMaxReadLimit(inputStream);
+ return new ContentStreamProvider() {
+ private boolean first = true;
+ @Override
+ public InputStream newStream() {
+ if (first) {
+ first = false;
+ return inputStream;
+ }
+
+ if (inputStream.markSupported()) {
+ invokeSafely(inputStream::reset);
+ return inputStream;
+ }
+
+ throw new IllegalStateException("Content input stream does not support mark/reset, "
+ + "and was already read once.");
+ }
+ };
+ }
+
+ /**
+ * Create {@link ContentStreamProvider} from an input stream supplier. Each time a new stream is retrieved from
+ * this content stream provider, the last one returned will be closed.
+ */
+ static ContentStreamProvider fromInputStreamSupplier(Supplier Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account. Disables (opts-out) a particular Region for an account. Disables (opts-out) a particular Region for an account. The act of disabling a Region will remove all IAM access to any resources that reside in that Region. Retrieves the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update the primary and alternate contact information. Retrieves the primary email address for the specified account. Updates the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update the primary and alternate contact information. Starts the process to update the primary email address for the specified account. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. The management account can't specify its own The OTP code sent to the The new primary email address for use with the specified account. This must match the Retrieves the status of the accepted primary email update request. The state or region of the primary contact address. This field is required in selected countries. The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. The management account can't specify its own Retrieves the primary email address associated with the specified account. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. The management account can't specify its own The new primary email address (also known as the root user email address) to use in the specified account. The status of the primary email update request. Creates an assessment in Audit Manager. Gets a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an assessment, specify which of these services you want to include to narrow the assessment's scope. Gets a list of the Amazon Web Services from which Audit Manager can collect evidence. Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list. For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide. Lists the latest analytics data for control domains across all of your active assessments. A control domain is listed only if at least one of the controls within that domain collected evidence on the Lists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see A control domain is listed only if at least one of the controls within that domain collected evidence on the Lists analytics data for control domains within a specified active assessment. A control domain is listed only if at least one of the controls within that domain collected evidence on the Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see A control domain is listed only if at least one of the controls within that domain collected evidence on the Returns a list of keywords that are pre-mapped to the specified control data source. Returns a list of keywords that are pre-mapped to the specified control data source. Edits an Audit Manager assessment. The tags associated with the control. The state of the control. The A control in Audit Manager. The name of the control domain. The unique identifier for the control domain. The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see The name of the assessment control. The unique identifier for the assessment control. The name of the control. The unique identifier for the control. The setup option for the data source. This option reflects if the evidence collection is automated or manual. The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for Specifies one of the five data source types for evidence collection. Specifies which type of data source is used to collect evidence. The source can be an individual data source type, such as The source can also be a managed grouping of data sources, such as a The setup option for the data source, which reflects if the evidence collection is automated or manual. The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for Specifies one of the five types of data sources for evidence collection. Specifies which type of data source is used to collect evidence. The source can be an individual data source type, such as The source can also be a managed grouping of data sources, such as a The instructions for troubleshooting the control. The control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This doesn't contain The mapping attributes that determine the evidence source for a given control, along with related parameters and metadata. This doesn't contain The unique identifier for the control domain. The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see The unique identifier for the control domain. The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see The type of control, such as a standard control or a custom control. A filter that narrows the list of controls to a specific type. The pagination token that's used to fetch the next set of results. The pagination token that's used to fetch the next set of results. Represents the maximum number of results on a page or for an API request call. The maximum number of results on a page or for an API request call. A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog. To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the Alternatively, specify The pagination token that's used to fetch the next set of results. The pagination token that's used to fetch the next set of results. The control mapping data source that the keywords apply to. The control mapping data source that the keywords apply to. The list of keywords for the event mapping source. The list of keywords for the control mapping source. The Amazon Web Services services that are included in the scope of the assessment. The Amazon Web Services services that are included in the scope of the assessment. This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services, Audit Manager ignores this input. Instead, the value for The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment. The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment. You no longer need to specify which Amazon Web Services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services. If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment. The request was denied due to request throttling. Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network. Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file. Gets a summary of the most recent executions for a pipeline. Gets a summary of the most recent executions for a pipeline. When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024. The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. Detailed execution history is available for executions run on or after February 21, 2019. The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. The source revision, or version of your source artifact, with the changes that you want to run in the pipeline execution. A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution. A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution. For the Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to To check the encryption status of a delivery stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type For the KMS grant creation to be successful, Firehose APIs If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get If the encryption status of your delivery stream is You can enable SSE for a delivery stream only if it's a delivery stream that uses The Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to To check the encryption status of a delivery stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type For the KMS grant creation to be successful, the Firehose API operations If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get If the encryption status of your delivery stream is You can enable SSE for a delivery stream only if it's a delivery stream that uses The The configuration of the requeste sent to the HTTP endpoint specified as the destination. The configuration of the request sent to the HTTP endpoint that is specified as the destination. Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination. You can back up all documents ( The configuration that defines how you access secrets for HTTP Endpoint destination. Describes the configuration of the HTTP endpoint destination. Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents ( The configuration that defines how you access secrets for HTTP Endpoint destination. Describes the HTTP endpoint destination. Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents ( The configuration that defines how you access secrets for HTTP Endpoint destination. Updates the specified HTTP endpoint destination. Indicates the version of row format to output. The possible values are A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet. A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet. The CloudWatch logging options for your delivery stream. The configuration that defines how you access secrets for Amazon Redshift. Describes the configuration of a destination in Amazon Redshift. The Amazon CloudWatch logging options for your delivery stream. The configuration that defines how you access secrets for Amazon Redshift. Describes a destination in Amazon Redshift. The Amazon CloudWatch logging options for your delivery stream. The configuration that defines how you access secrets for Amazon Redshift. Describes an update for a destination in Amazon Redshift. Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3. This parameter is required if The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk. Specifies whether you want to use the the secrets manager feature. When set as The structure that defines how Firehose accesses the secret. Choose an S3 backup mode The configuration that defines how you access secrets for Snowflake. Configure Snowflake destination Choose an S3 backup mode The configuration that defines how you access secrets for Snowflake. Optional Snowflake destination description Choose an S3 backup mode Describes the Secrets Manager configuration in Snowflake. Update to configuration settings The buffering options. If no value is specified, the default values for Splunk are used. The configuration that defines how you access secrets for Splunk. Describes the configuration of a destination in Splunk. The buffering options. If no value is specified, the default values for Splunk are used. The configuration that defines how you access secrets for Splunk. Describes a destination in Splunk. The buffering options. If no value is specified, the default values for Splunk are used. The configuration that defines how you access secrets for Splunk. Describes an update for a destination in Splunk. Update to the Snowflake destination condiguration settings Update to the Snowflake destination configuration settings. The details of the VPC of the Amazon ES destination. Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose. Amazon Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations. Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose. Amazon Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supported destinations. Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a If a file system with the specified client request token exists and the parameters match, Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of Returns the description of the file system in JSON format. The Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a If a file system with the specified client request token exists and the parameters match, Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of Returns the description of the file system in JSON format. The Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted. To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a The If a data repository task is in a The data in a deleted file system is also deleted and can't be recovered by any means. Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted. To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a The If a data repository task is in a The data in a deleted file system is also deleted and can't be recovered by any means. Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For FSx for Windows File Server file systems, you can update the following properties: For FSx for Lustre file systems, you can update the following properties: For FSx for ONTAP file systems, you can update the following properties: For FSx for OpenZFS file systems, you can update the following properties: Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For FSx for Windows File Server file systems, you can update the following properties: For FSx for Lustre file systems, you can update the following properties: For FSx for ONTAP file systems, you can update the following properties: For FSx for OpenZFS file systems, you can update the following properties: (Optional) Choose Choose Choose If you choose Encryption of data in transit is automatically turned on when you access (Default = (Optional) Choose Choose Choose If you choose Encryption of data in transit is automatically turned on when you access (Default = The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a The Lustre configuration for the file system being created. The following parameters are not supported for file systems with a data repository association created with . (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision for the file system. This parameter sets the maximum rate of metadata disk IOPS supported by the file system. Valid values are Iops doesn’t have a default value. If you're using USER_PROVISIONED mode, you can choose to specify a valid value. If you're using AUTOMATIC mode, you cannot specify a value because FSx for Lustre automatically sets the value based on your file system storage capacity. The metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS for your file system based on your file system storage capacity. In USER_PROVISIONED mode, you specify the number of Metadata IOPS to provision for your file system. The Lustre metadata performance configuration for the creation of an Amazon FSx for Lustre file system using a After creation, the file system supports increasing metadata performance. For more information on Metadata IOPS, see Lustre metadata performance configuration in the Amazon FSx for Lustre User Guide. Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: The value of The value of Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: The value of The value of Sets the storage capacity of the file system that you're creating, in gibibytes (GiB). FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for For For For FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). Sets the storage capacity of the file system that you're creating, in gibibytes (GiB). FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for For For For FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). Sets the storage type for the file system that you're creating. Valid values are Set to Set to Default value is Sets the storage type for the file system that you're creating. Valid values are Set to Set to Default value is (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types. 2.12 and 2.15 are supported by all Lustre deployment types. Default value = If you set For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are Default value is Default value is Default value is Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values: For more information, see Volume security style in the FSx for ONTAP User Guide. Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values: For more information, see Volume security style in the FSx for ONTAP User Guide. Specifies the type of volume you are creating. Valid values are the following: For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide. Specifies the type of volume you are creating. Valid values are the following: For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide. Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide. Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide. The security style of the root volume of the SVM. Specify one of the following values: The security style of the root volume of the SVM. Specify one of the following values: The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths: The path can be an NFS data repository that links to the cache. The path can be in one of two formats: If you are not using the If you are using the The path can be an S3 bucket or prefix in the format The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths: The path can be an NFS data repository that links to the cache. The path can be in one of two formats: If you are not using the If you are using the The path can be an S3 bucket or prefix in the format The number of Metadata IOPS provisioned for the file system. Valid values are The metadata configuration mode for provisioning Metadata IOPS for the file system. In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. The Lustre metadata performance configuration of an Amazon FSx for Lustre file system using a An enumeration specifying the currently ongoing maintenance operation. The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a The configuration for the Amazon FSx for Lustre file system. Specifies the updated user name for the service account on your self-managed AD domain. Amazon FSx uses this account to join to your self-managed AD domain. This account must have the permissions required to join computers to the domain in the organizational unit provided in Specifies the updated user name for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. This account must have the permissions required to join computers to the domain in the organizational unit provided in Specifies the updated password for the service account on your self-managed AD domain. Amazon FSx uses this account to join to your self-managed AD domain. Specifies the updated password for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. A list of up to three DNS server or domain controller IP addresses in your self-managed AD domain. A list of up to three DNS server or domain controller IP addresses in your self-managed Active Directory domain. Specifies an updated fully qualified domain name of your self-managed AD configuration. Specifies an updated fully qualified domain name of your self-managed Active Directory configuration. Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD. Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory. Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges for the Amazon FSx resource. For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges for the Amazon FSx resource. Specifies changes you are making to the self-managed Microsoft Active Directory (AD) configuration to which an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined. Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined. The throughput of an Amazon FSx for Lustre Persistent SSD-based file system, measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease your file system's throughput. Valid values depend on the deployment type of the file system, as follows: For For For more information, see Managing throughput capacity. The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a The configuration object for Amazon FSx for Lustre file systems used in the (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision for your file system. Valid values are The value you provide must be greater than or equal to the current number of Metadata IOPS provisioned for the file system. The metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a To increase the Metadata IOPS or to switch from AUTOMATIC mode, specify To switch from USER_PROVISIONED mode, specify If you request to switch from USER_PROVISIONED to AUTOMATIC mode and the current Metadata IOPS value is greater than the automated default, FSx for Lustre rejects the request because downscaling Metadata IOPS is not supported. The Lustre metadata performance configuration update for an Amazon FSx for Lustre file system using a The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK. The IP addresses for an accelerator. Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted. The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4. The IP addresses for an accelerator. Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted. A structure containing the authentication configuration. The secret manager ARN to store credentials. The properties for OAuth2 authentication. A structure containing the authentication configuration. A structure containing the authentication configuration in the CreateConnection request. The secret manager ARN to store credentials in the CreateConnection request. The properties for OAuth2 authentication in the CreateConnection request. A structure containing the authentication configuration in the CreateConnection request. An authorization code to be used in the third leg of the The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token. The set of properties required for the the OAuth2 A map of physical connection requirements, such as virtual private cloud (VPC) and The physical connection requirements, such as virtual private cloud (VPC) and The time that this connection definition was created. The timestamp of the time that this connection definition was created. The last time that this connection definition was updated. The timestamp of the last time the connection definition was updated. The user, group, or role that last updated this connection definition. The status of the connection. Can be one of: The reason for the connection status. A timestamp of the time this connection was last validated. The authentication properties of the connection. Defines a connection to a data source. The name of the connection. Connection will not function as expected without a name. The name of the connection. The type of the connection. Currently, these types are supported: Required: All of ( Required: All of ( Optional: Required: Optional: Optional: Optional: Optional: Optional: Required: Required: All of ( Required: Required for For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties. For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections. The type of the connection. Currently, these types are supported: Required: All of ( Required: All of ( Optional: Required: Optional: Optional: Optional: Optional: Optional: Required: Required: All of ( Requires the Required: Required for For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties. For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections. A map of physical connection requirements, such as virtual private cloud (VPC) and The physical connection requirements, such as virtual private cloud (VPC) and The authentication properties of the connection. Used for a Salesforce connection. A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true. A structure that is used to specify a connection to create or update. The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC. The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days. The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days. The The maximum value for timeout for batch jobs is 7 days or 10080 minutes. The default is 2880 minutes (48 hours) for batch jobs. Any existing Glue jobs that have a greater timeout value are defaulted to 7 days. For instance you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day. Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days. The Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days. The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days. Defines column statistics supported for integer data columns. The client application clientID if the ClientAppType is The reference to the SaaS-side client app that is Amazon Web Services managed. The OAuth2 client app used for the connection. The OAuth2 grant type. For example, The client application type. For example, AWS_MANAGED or USER_MANAGED. The URL of the provider's authentication server, to exchange an authorization code for an access token. A map of parameters that are added to the token A structure containing properties for OAuth2 authentication. The OAuth2 grant type in the CreateConnection request. For example, The client application type in the CreateConnection request. For example, The URL of the provider's authentication server, to exchange an authorization code for an access token. A map of parameters that are added to the token The set of properties required for the the OAuth2 A structure containing properties for OAuth2 in the CreateConnection request. The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future. The connection's Availability Zone. Specifies the physical requirements for a connection. The OAuth client app in GetConnection response. When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide. The Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours). The Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days. A A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query. A structure used to define a table. The version ID at which to update the table contents. The operation to be performed when updating the view. A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements. A structure containing details for representations. You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any. The definer of a view in SQL. A list of structures that contains the dialect of the view, and the query that defines the view. A list of base table ARNs that make up the view. A structure containing details for creating or updating an Glue view. The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform Fully qualify identifiers: The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform Fully qualified identifiers: The name of the connection to be used to validate the specific representation of the view. A structure that contains the dialect of the view, and the query that defines the view. A parameter that specifies the engine type of a specific representation. A parameter that specifies the version of the engine of a specific representation. A string that represents the original SQL query that describes the view. The name of the connection to be used to validate the specific representation of the view. A string that represents the SQL query that describes the view with expanded resource ARNs A structure containing details of a representation to update or create a Lake Formation view. 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. Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence: Retrieves the geofence details from a geofence collection. Retrieves the geofence details from a geofence collection. The returned geometry will always match the geometry format used when the geofence was created. Updates the specified properties of a given tracker resource. Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state. A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action. The following are valid values for the actions. Map actions Place actions Route actions You must use these strings exactly. For example, to provide access to map rendering, the only valid action is An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes. May contain wildcard characters question mark (?) and asterisk (*). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits). No spaces allowed. For example, A list of allowed resource ARNs that a API key bearer can perform actions on. The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type. The resources must be in the same Other than wildcards, you must include the full ARN, including the No spaces allowed, even with wildcards. For example, For more information about ARN format, see Amazon Resource Names (ARNs). An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes. May contain wildcard characters question mark (?) and asterisk (*). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits). No spaces allowed. For example, API Restrictions on the allowed actions, resources, and referers for an API key resource. The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The name of the tracker resource to be associated with a geofence collection. The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: Devices whose position history you want to delete. For example, for two devices: The name of the tracker resource to delete the device position history from. Devices whose position history you want to delete. For example, for two devices: Contains details associated to the batch error. The geofence associated with the error message. Contains details associated to the batch error. Contains error details for each geofence that failed to delete from the geofence collection. The device associated with the position evaluation error. Contains details associated to the batch error. Specifies a timestamp for when the error occurred in ISO 8601 format: Contains details associated to the batch error. Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection. Devices whose position you want to retrieve. For example, for two devices: The tracker resource retrieving the device position. Devices whose position you want to retrieve. For example, for two devices: Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled. Contains error details for each device that failed to send its position to the tracker resource. Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled. Contains details associated to the batch error. The geofence associated with the error message. Contains details associated to the batch error. Contains error details for each geofence that failed to be stored in a given geofence collection. The identifier for the geofence to be stored in a given geofence collection. Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error. The geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices. Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error. Each geofence polygon can have a maximum of 1,000 vertices. Contains geofence geometry details. Contains additional error details for each geofence that failed to be stored in a geofence collection. Contains each geofence that was successfully stored in a geofence collection. Contains additional error details for each geofence that failed to be stored in a geofence collection. The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: The geofence successfully stored in a geofence collection. The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: The timestamp for when the geofence was last updated in ISO 8601 format: The device associated with the failed location update. Contains details related to the error code such as the error code and error message. The timestamp at which the device position was determined. Uses ISO 8601 format: Contains details related to the error code such as the error code and error message. Contains error details for each device that failed to update its position. Specifies route preferences when traveling by Requirements: Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both Default Value: Valid Values: The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide. For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in Valid Values: The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide. For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in Valid Values: Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. The If traveling by If traveling by For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide. Default Value: Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both Setting a departure time in the past returns a In ISO 8601 format: The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide. For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in Valid Values: Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both Default Value: Valid Values: Set the unit system to specify the distance. Default Value: Specifies route preferences when traveling by Requirements: Specifies route preferences when traveling by Requirements: The optional API key to authorize the request. Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. The If traveling by If traveling by For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide. Default Value: Specifies route preferences when traveling by Requirements: The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers: For more information about data providers, see Amazon Location Service data providers. The unit of measurement for route distances. The count of cells in the route matrix. Equal to the number of The count of error results in the route matrix. If this number is 0, all routes were calculated successfully. The count of cells in the route matrix. Equal to the number of The unit of measurement for route distances. A summary of the calculated route matrix. Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. ArrivalTime is not supported Esri. The name of the route calculator resource that you want to use to calculate the route. Specifies route preferences when traveling by Requirements: Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. Default Value: Valid Values: The start position for the route. Defined in World Geodetic System (WGS 84) format: For example, If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a Valid Values: The finish position for the route. Defined in World Geodetic System (WGS 84) format: For example, If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. Valid Values: Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. For example, from the If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road. Specifying more than 23 waypoints returns a If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a Valid Values: Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide. The If traveling by If traveling by Default Value: Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. In ISO 8601 format: The finish position for the route. Defined in World Geodetic System (WGS 84) format: For example, If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. Valid Values: Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. Default Value: Valid Values: Set to include the geometry details in the result for each path between a pair of positions. Default Value: Valid Values: The optional API key to authorize the request. Specifies the distance to optimize for when calculating a route. Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide. The If traveling by If traveling by Default Value: Specifies route preferences when traveling by Requirements: Specifies route preferences when traveling by Requirements: Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position. For example, from the If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road. Specifying more than 23 waypoints returns a If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a Valid Values: Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route. ArrivalTime is not supported Esri. Specifies the distance to optimize for when calculating a route. The optional API key to authorize the request. Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, The first 2 The first The second The next 2 The third The fourth The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers: For more information about data providers, see Amazon Location Service data providers. The total distance covered by the route. The sum of the distance travelled between every stop on the route. If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a The unit of measurement for route distances. The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route. Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, The first 2 The first The second The next 2 The third The fourth The unit of measurement for route distances. A summary of the calculated route. Contains details about additional route preferences for requests that specify Information about the Long-Term Evolution (LTE) network the device is connected to. The cellular network communication infrastructure that the device uses. A custom name for the geofence collection. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique geofence collection name. No spaces allowed. For example, An optional description for the geofence collection. A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. No longer used. If included, the only allowed value is An optional description for the geofence collection. Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix for a key. A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The name for the geofence collection. The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The timestamp for when the geofence collection was created in ISO 8601 format: A custom name for the API key resource. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique API key name. No spaces allowed. For example, The API key restrictions for the API key resource. An optional description for the API key resource. The optional timestamp for when the API key resource will expire in ISO 8601 format: A custom name for the API key resource. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique API key name. No spaces allowed. For example, Optionally set to The API key restrictions for the API key resource. Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them. Format: Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix for a key. The timestamp for when the API key resource was created in ISO 8601 format: The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs. The name of the API key resource. The timestamp for when the API key resource was created in ISO 8601 format: Specifies the An optional description for the map resource. The name for the map resource. Requirements: Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique map resource name. No spaces allowed. For example, Specifies the No longer used. If included, the only allowed value is An optional description for the map resource. Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix for a key. The timestamp for when the map resource was created in ISO 8601 format: The name of the map resource. The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services. Format example: The name of the map resource. The timestamp for when the map resource was created in ISO 8601 format: Specifies the geospatial data provider for the new place index. This field is case-sensitive. Enter the valid values as shown. For example, entering Valid values include: If you specify HERE Technologies ( For additional information , see Data providers on the Amazon Location Service Developer Guide. Specifies the data storage option requesting Places. The optional description for the place index resource. The name of the place index resource. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). Must be a unique place index resource name. No spaces allowed. For example, Specifies the geospatial data provider for the new place index. This field is case-sensitive. Enter the valid values as shown. For example, entering Valid values include: If you specify HERE Technologies ( For additional information , see Data providers on the Amazon Location Service Developer Guide. No longer used. If included, the only allowed value is The optional description for the place index resource. Specifies the data storage option requesting Places. Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources. Format: Restrictions: Maximum 50 tags per resource. Each tag key must be unique and must have exactly one associated value. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256 Unicode characters in UTF-8. Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @ Cannot use \"aws:\" as a prefix for a key. The timestamp for when the place index resource was created in ISO 8601 format: The name for the place index resource. The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services. Format example: The name for the place index resource. The timestamp for when the place index resource was created in ISO 8601 format: Specifies the data provider of traffic and road network data. This field is case-sensitive. Enter the valid values as shown. For example, entering Valid values include: Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km. For additional information , see Data providers on the Amazon Location Service Developer Guide. The optional description for the route calculator resource. No longer used. If included, the only allowed value is The optional description for the route calculator resource. Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. For example: { Format: Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix for a key. The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services. Format example: The name of the route calculator resource. For example, The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services. Format example: The timestamp when the route calculator resource was created in ISO 8601 format: For example, An optional description for the tracker resource. Whether to enable position You do not need enable this feature to get Enables This parameter is only used if you are using a KMS customer managed key. If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. Specifies the position filtering for the tracker resource. Valid values: This field is optional. If not specified, the default value is The name for the tracker resource. Requirements: Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). Must be a unique tracker resource name. No spaces allowed. For example, A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. This parameter is no longer used. An optional description for the tracker resource. Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: Restrictions: Maximum 50 tags per resource Each resource tag must be unique with a maximum of one value. Maximum key length: 128 Unicode characters in UTF-8 Maximum value length: 256 Unicode characters in UTF-8 Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. Cannot use \"aws:\" as a prefix for a key. The name for the tracker resource. Requirements: Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). Must be a unique tracker resource name. No spaces allowed. For example, Specifies the position filtering for the tracker resource. Valid values: This field is optional. If not specified, the default value is Whether to enable position You do not need enable this feature to get Enables This parameter is only used if you are using a KMS customer managed key. If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the The timestamp for when the tracker resource was created in ISO 8601 format: The name of the tracker resource. The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The name of the tracker resource. The timestamp for when the tracker resource was created in ISO 8601 format: ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter Valid values: Required: No This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use. The name of the API key to delete. ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter Valid values: Required: No This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use. The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The name of the geofence collection. The timestamp for when the geofence resource was created in ISO 8601 format: The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The optional description for the geofence collection. The number of geofences in the geofence collection. A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource No longer used. Always returns A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource Displays the key, value pairs of tags associated with this resource. The timestamp for when the geofence resource was created in ISO 8601 format: The timestamp for when the geofence collection was last updated in ISO 8601 format: The number of geofences in the geofence collection. The timestamp for when the API key resource was created in ISO 8601 format: The optional description for the API key resource. The timestamp for when the API key resource will expire in ISO 8601 format: The key value/string of an API key. The name of the API key resource. Tags associated with the API key resource. The timestamp for when the API key resource was created in ISO 8601 format: The timestamp for when the API key resource will expire in ISO 8601 format: The timestamp for when the API key resource was last updated in ISO 8601 format: The optional description for the API key resource. Tags associated with the API key resource. Specifies the map tile style selected from a partner data provider. The timestamp for when the map resource was created in ISO 8601 format: Specifies the data provider for the associated map tiles. The optional description for the map resource. The map style selected from an available provider. The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services. Format example: The map style selected from an available provider. No longer used. Always returns Specifies the data provider for the associated map tiles. Specifies the map tile style selected from a partner data provider. The optional description for the map resource. Tags associated with the map resource. The timestamp for when the map resource was created in ISO 8601 format: The timestamp for when the map resource was last update in ISO 8601 format: The timestamp for when the place index resource was created in ISO 8601 format: The data provider of geospatial data. Values can be one of the following: For more information about data providers, see Amazon Location Service data providers. The specified data storage option for requesting Places. The optional description for the place index resource. The name of the place index resource being described. The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services. Format example: The name of the place index resource being described. No longer used. Always returns Tags associated with place index resource. The optional description for the place index resource. The timestamp for when the place index resource was created in ISO 8601 format: The timestamp for when the place index resource was last updated in ISO 8601 format: The data provider of geospatial data. Values can be one of the following: For more information about data providers, see Amazon Location Service data providers. The specified data storage option for requesting Places. Tags associated with place index resource. The name of the route calculator resource being described. The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services. Format example: The name of the route calculator resource being described. Always returns The optional description of the route calculator resource. The timestamp when the route calculator resource was created in ISO 8601 format: For example, The timestamp when the route calculator resource was last updated in ISO 8601 format: For example, The data provider of traffic and road network data. Indicates one of the available providers: For more information about data providers, see Amazon Location Service data providers. The optional description of the route calculator resource. Always returns Tags associated with route calculator resource. The timestamp when the route calculator resource was last updated in ISO 8601 format: For example, The timestamp for when the tracker resource was created in ISO 8601 format: The name of the tracker resource. The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The optional description for the tracker resource. Whether Enables This parameter is only used if you are using a KMS customer managed key. If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource. The position filtering method of the tracker resource. Always returns The tags associated with the tracker resource. The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The name of the tracker resource. The timestamp for when the tracker resource was created in ISO 8601 format: The timestamp for when the tracker resource was last updated in ISO 8601 format: A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource. The position filtering method of the tracker resource. Whether Enables This parameter is only used if you are using a KMS customer managed key. If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the The accuracy of the device position. The device whose position you retrieved. The timestamp at which the device's position was determined. Uses ISO 8601 format: The timestamp for when the tracker resource received the device position in ISO 8601 format: The last known device position. The accuracy of the device position. The properties associated with the position. The timestamp for when the tracker resource received the device position in ISO 8601 format: The timestamp at which the device's position was determined. Uses ISO 8601 format: Contains the device position details. The device associated to the position update. The timestamp at which the device's position was determined. Uses ISO 8601 format: The latest device position defined in WGS 84 format: The accuracy of the device position. Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger. Format: Contains the position update details for a device. The device associated to the position update. The device identifier. The timestamp at which the device's position was determined. Uses ISO 8601 format: The latest device position defined in WGS 84 format: The last known device position. Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger. Format: The device's Ipv4 address. The timestamp at which the device's position was determined. Uses ISO 8601 format: The Wi-Fi access points the device is using. The cellular network infrastructure that the device is connected to. Contains the position update details for a device. The device's position, IP address, and Wi-Fi access points. The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The name of the tracker resource to be dissociated from the consumer. The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: The device's position. The device's speed. The device's position, IP address, and WiFi access points. The name of the geofence collection. The device's state, including current position and speed. Specifies the time horizon in minutes for the forecasted events. The distance unit used for the Default Value: The speed unit for the device captured by the device state. The measurement system must match for Default Value: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: An optional limit for the number of resources returned in a single call. Default value: The list of forecasted events. The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. The distance unit for the forecasted events. The speed unit for the forecasted events. The forecasted event identifier. The geofence identifier pertaining to the forecasted event. Indicates if the device is located within the geofence. The closest distance from the device's position to the geofence. The event type, forecasting three states for which a device can be in relative to a geofence: The forecasted time the device will breach the geofence in ISO 8601 format: The geofence properties. A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon. A polygon is a list of linear rings which are each made up of a list of vertices. Each vertex is a 2-dimensional point of the form: An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( A linear ring for use in geofences can consist of between 4 and 1,000 vertices. A circle on the earth, as defined by a center point and a radius. A polygon is a list of linear rings which are each made up of a list of vertices. Each vertex is a 2-dimensional point of the form: An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( A linear ring for use in geofences can consist of between 4 and 1,000 vertices. Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded. A polygon in Geobuf format can have up to 100,000 vertices. Contains the geofence geometry details. A geofence geometry is made up of either a polygon or a circle. Can be either a polygon or a circle. Including both will return a validation error. Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian. Contains the geofence geometry details. A geofence geometry is made up of either a polygon or a circle. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error. Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian. The tracker resource receiving the request for the device position history. The device whose position history you want to retrieve. Specify the end time for the position history in ISO 8601 format: Requirement: The time specified for An optional limit for the number of device positions returned in a single call. Default value: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: Specify the start time for the position history in ISO 8601 format: Requirement: The time specified for The tracker resource receiving the request for the device position history. Specify the end time for the position history in ISO 8601 format: Requirement: The time specified for An optional limit for the number of device positions returned in a single call. Default value: The device whose position you want to retrieve. The tracker resource receiving the position update. The device whose position you want to retrieve. The accuracy of the device position. The device whose position you retrieved. The timestamp at which the device's position was determined. Uses ISO 8601 format: The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: The last known device position. The accuracy of the device position. The properties associated with the position. The timestamp for when the tracker resource received the device position in ISO 8601 format: The timestamp at which the device's position was determined. Uses ISO 8601 format: The timestamp for when the geofence collection was created in ISO 8601 format: The geofence identifier. User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: Contains the geofence geometry details describing a polygon or a circle. Identifies the state of the geofence. A geofence will hold one of the following states: The timestamp for when the geofence collection was created in ISO 8601 format: The timestamp for when the geofence collection was last updated in ISO 8601 format: User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: The map resource associated with the glyph file. A comma-separated list of fonts to load glyphs from in order of preference. For example, Valid font stacks for Esri styles: VectorEsriDarkGrayCanvas – VectorEsriLightGrayCanvas – VectorEsriTopographic – VectorEsriStreets – VectorEsriNavigation – Valid font stacks for HERE Technologies styles: VectorHereContrast – VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Valid font stacks for GrabMaps styles: VectorGrabStandardLight, VectorGrabStandardDark – Valid font stacks for Open Data styles: VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – The fonts used by the Open Data map styles are combined fonts that use A comma-separated list of fonts to load glyphs from in order of preference. For example, Valid font stacks for Esri styles: VectorEsriDarkGrayCanvas – VectorEsriLightGrayCanvas – VectorEsriTopographic – VectorEsriStreets – VectorEsriNavigation – Valid font stacks for HERE Technologies styles: VectorHereContrast – VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Valid font stacks for GrabMaps styles: VectorGrabStandardLight, VectorGrabStandardDark – Valid font stacks for Open Data styles: VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – The fonts used by the Open Data map styles are combined fonts that use The optional API key to authorize the request. The map resource associated with the glyph file. The glyph, as binary blob. The HTTP Cache-Control directive for the value. The map glyph content type. For example, The HTTP Cache-Control directive for the value. The map resource associated with the sprite file. The name of the sprite file. Use the following file names for the sprite sheet: For the JSON document containing image offsets. Use the following file names: The optional API key to authorize the request. The map resource associated with the sprite file. The optional API key to authorize the request. Contains the body of the sprite sheet or JSON offset file. The HTTP Cache-Control directive for the value. The content type of the sprite sheet and offsets. For example, the sprite sheet content type is The HTTP Cache-Control directive for the value. The optional API key to authorize the request. The map resource to retrieve the style descriptor from. The optional API key to authorize the request. Contains the body of the style descriptor. The HTTP Cache-Control directive for the value. The style descriptor's content type. For example, The HTTP Cache-Control directive for the value. The optional API key to authorize the request. The map resource to retrieve the map tiles from. The zoom value for the map tile. The X axis value for the map tile. The zoom value for the map tile. The optional API key to authorize the request. Contains Mapbox Vector Tile (MVT) data. The HTTP Cache-Control directive for the value. The map tile's content type. For example, The HTTP Cache-Control directive for the value. The optional API key to authorize the request. The identifier of the place to find. The identifier of the place to find. While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider: Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent. HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week. Grab: Place IDs can expire or become invalid in the following situations. Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis. Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the The optional API key to authorize the request. The device position inferred by the provided position, IP address, cellular signals, and Wi-Fi- access points. The level of certainty of the inferred position. The distance between the inferred position and the device's self-reported position. Indicates if a proxy was used. The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points. The starting position of the leg. Follows the format If the The terminating position of the leg. Follows the format If the The distance between the leg's The default measurement is The estimated travel time between the leg's The terminating position of the leg. Follows the format If the Contains the calculated route's path as a linestring geometry. The starting position of the leg. Follows the format If the Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset. The geometry used to filter device positions. The tracker resource containing the requested devices. The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: The tracker resource containing the requested devices. The geometry used to filter device positions. The accuracy of the device position. The ID of the device for this position. The timestamp at which the device position was determined. Uses ISO 8601 format: The last known device position. Empty if no positions currently stored. The accuracy of the device position. The properties associated with the position. The timestamp at which the device position was determined. Uses ISO 8601 format: Contains the tracker resource details. The name of the geofence collection. The timestamp for when the geofence collection was created in ISO 8601 format: The description for the geofence collection The timestamp for when the geofence collection was created in ISO 8601 format: Specifies a timestamp for when the resource was last updated in ISO 8601 format: Contains the geofence collection details. Contains the geofence collection details. The returned geometry will always match the geometry format used when the geofence was created. The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: The geofence identifier. User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: Contains the geofence geometry details describing a polygon or a circle. Identifies the state of the geofence. A geofence will hold one of the following states: The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: The timestamp for when the geofence was last updated in ISO 8601 format: User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: Contains a list of geofences stored in a given geofence collection. Contains a list of geofences stored in a given geofence collection. The returned geometry will always match the geometry format used when the geofence was created. The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: An optional limit for the number of geofences returned in a single call. Default value: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: Contains a list of geofences stored in the geofence collection. A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. Optionally filter the list to only An optional limit for the number of resources returned in a single call. Default value: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: Optionally filter the list to only The name of the API key resource. The timestamp of when the API key was created, in ISO 8601 format: The timestamp for when the API key resource will expire, in ISO 8601 format: The optional description for the API key resource. The timestamp for when the API key resource will expire, in ISO 8601 format: The name of the API key resource. The timestamp of when the API key was created, in ISO 8601 format: The timestamp of when the API key was last updated, in ISO 8601 format: The timestamp for when the map resource was created in ISO 8601 format: Specifies the data provider for the associated map tiles. The name of the associated map resource. The description for the map resource. The name of the associated map resource. Specifies the data provider for the associated map tiles. The timestamp for when the map resource was created in ISO 8601 format: The timestamp for when the map resource was last updated in ISO 8601 format: The timestamp for when the place index resource was created in ISO 8601 format: The data provider of geospatial data. Values can be one of the following: For more information about data providers, see Amazon Location Service data providers. The name of the place index resource. The optional description for the place index resource. The name of the place index resource. The data provider of geospatial data. Values can be one of the following: For more information about data providers, see Amazon Location Service data providers. The timestamp for when the place index resource was created in ISO 8601 format: The timestamp for when the place index resource was last updated in ISO 8601 format: The name of the route calculator resource. The timestamp when the route calculator resource was created in ISO 8601 format: For example, The optional description of the route calculator resource. The data provider of traffic and road network data. Indicates one of the available providers: For more information about data providers, see Amazon Location Service data providers. The optional description of the route calculator resource. Always returns The timestamp when the route calculator resource was created in ISO 8601 format: For example, The timestamp when the route calculator resource was last updated in ISO 8601 format: For example, The tracker resource whose associated geofence collections you want to list. An optional limit for the number of resources returned in a single call. Default value: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: The tracker resource whose associated geofence collections you want to list. The timestamp for when the tracker resource was created in ISO 8601 format: The name of the tracker resource. The name of the tracker resource. The timestamp for when the tracker resource was created in ISO 8601 format: The E-UTRAN Cell Identifier (ECI). The Mobile Country Code (MCC). The Mobile Network Code (MNC) The LTE local identification information (local ID). The network measurements. Timing Advance (TA). Indicates whether the LTE object is capable of supporting NR (new radio). Signal power of the reference signal received, measured in decibel-milliwatts (dBm). Signal quality of the reference Signal received, measured in decibels (dB). LTE Tracking Area Code (TAC). Details about the Long-Term Evolution (LTE) network. E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN). Physical Cell ID (PCI). LTE local identification information (local ID). E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN). E-UTRAN Cell Identifier (ECI). Physical Cell ID (PCI). Signal power of the reference signal received, measured in dBm (decibel-milliwatts). Signal quality of the reference Signal received, measured in decibels (dB). LTE network measurements. Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as Currenlty only Specifies the map style selected from an available data provider. Valid Esri map styles: Valid HERE Technologies map styles: The Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved. Valid GrabMaps map styles: Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region ( Valid Open Data map styles: Specifies the political view for the style. Leave unset to not use a political view, or, for styles that support specific political views, you can choose a view, such as Default is unset. Not all map resources or styles support political view styles. See Political views for more information. Specifies the map style selected from an available data provider. Valid Esri map styles: Valid HERE Technologies map styles: Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved. The Valid GrabMaps map styles: Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region ( Valid Open Data map styles: Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style. Default is Not all map resources or styles support custom layers. See Custom Layers for more information. Specifies the map tile style selected from an available provider. Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as Currenlty only Specifies the political view for the style. Set to an empty string to not use a political view, or, for styles that support specific political views, you can choose a view, such as Not all map resources or styles support political view styles. See Political views for more information. Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style. Default is Not all map resources or styles support custom layers. See Custom Layers for more information. Specifies the political view for the style. The full name and address of the point of interest such as a city, region, or country. For example, The numerical portion of an address, such as a building number. The Amazon Location categories that describe this Place. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. A country/region specified using ISO 3166 3-digit country/region code. For example, Not returned when the partner does not provide the information. For example, returns The name for a street or a road to identify a location. For example, The full name and address of the point of interest such as a city, region, or country. For example, The name of a community district. For example, A name for a local area, such as a city or town name. For example, The name of a community district. For example, A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location. A county, or an area that's part of a larger region. For example, A name for an area or geographical division, such as a province or state name. For example, The name for a street or a road to identify a location. For example, An area that's part of a larger municipality. For example, This property is only returned for a place index that uses Esri as a data provider. The property is represented as a For more information about data providers, see Amazon Location Service data providers. A country/region specified using ISO 3166 3-digit country/region code. For example, A county, or an area that's part of a larger region. For example, A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location. Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories. Not returned when the partner does not provide the information. For example, returns The time zone in which the For addresses with a Returned only for a place index that uses Esri as a data provider. For addresses with multiple units, the unit identifier. Can include numbers and letters, for example This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for For addresses with multiple units, the unit identifier. Can include numbers and letters, for example Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for The Amazon Location categories that describe this Place. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories. For addresses with a This property is returned only for a place index that uses Esri as a data provider. An area that's part of a larger municipality. For example, This property supported by Esri and OpenData. The Esri property is Contains details about addresses or points of interest that match the search criteria. Not all details are included with all responses. Some details may only be returned by specific data partners. Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error. The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices. Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error. Each geofence polygon can have a maximum of 1,000 vertices. The timestamp for when the geofence was created in ISO 8601 format: The geofence identifier entered in the request. The timestamp for when the geofence was created in ISO 8601 format: The timestamp for when the geofence was last updated in ISO 8601 format: The distance in meters of a great-circle arc between the query position and the result. A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations. Details about the search result, such as its address and position. The distance in meters of a great-circle arc between the query position and the result. A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations. The unique identifier of the place. You can use this with the For The Amazon Location categories that describe the Place. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. The text of the place suggestion, typically formatted as an address string. The unique identifier of the Place. You can use this with the The For While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider: Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent. HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week. Grab: Place IDs can expire or become invalid in the following situations. Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis. Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the The unique identifier of the Place. You can use this with the The For The Amazon Location categories that describe the Place. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories. The text of the place suggestion, typically formatted as an address string. Contains a place suggestion resulting from a place suggestion query that is run on a place index resource. The distance in meters of a great-circle arc between the bias position specified and the result. A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations. Details about the search result, such as its address and position. The unique identifier of the place. You can use this with the For The distance in meters of a great-circle arc between the bias position specified and the result. A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations. The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1. Returned only when the partner selected is Esri or Grab. The unique identifier of the place. You can use this with the For Contains a search result from a text search query that is run on a place index resource. The optional API key to authorize the request. The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the If you set the If the data provider does not have a value for Greek, the result will be in a language that the provider does support. Specifies the longitude and latitude of the position to query. This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude. For example, An optional parameter. The maximum number of results returned per request. Default value: Specifies the longitude and latitude of the position to query. This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude. For example, The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the If you set the If the data provider does not have a value for Greek, the result will be in a language that the provider does support. The optional API key to authorize the request. Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned. Contains a summary of the request. Echoes the input values for Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned. The position specified in the request. Contains the optional result count limit that is specified in the request. Default value: The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following: Esri Grab Here For more information about data providers, see Amazon Location Service data providers. The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, Contains the optional result count limit that is specified in the request. Default value: The position specified in the request. A summary of the request sent by using The name of the place index resource you want to use for the search. The free-form partial text to use to generate place suggestions. For example, An optional parameter that indicates a preference for place suggestions that are closer to a specified position. If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude. For example, An optional parameter that limits the search results by returning only suggestions within a specified bounding box. If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box. For example, A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. An optional parameter that limits the search results by returning only suggestions within the provided list of countries. Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: The name of the place index resource you want to use for the search. The optional API key to authorize the request. An optional parameter. The maximum number of results returned per request. The default: The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for If you set the If the data provider does not have a value for Greek, the result will be in a language that the provider does support. An optional parameter. The maximum number of results returned per request. The default: A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. The free-form partial text to use to generate place suggestions. For example, The optional API key to authorize the request. A list of place suggestions that best match the search text. Contains a summary of the request. Echoes the input values for A list of place suggestions that best match the search text. The free-form partial text input specified in the request. Contains the coordinates for the optional bias position specified in the request. This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude. For example, The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following: Esri Grab Here For more information about data providers, see Amazon Location Service data providers. Contains the coordinates for the optional bounding box specified in the request. The optional category filter specified in the request. Contains the optional country filter specified in the request. The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, Contains the optional result count limit specified in the request. The free-form partial text input specified in the request. The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following: Esri Grab Here For more information about data providers, see Amazon Location Service data providers. The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, The optional category filter specified in the request. A summary of the request sent by using The name of the place index resource you want to use for the search. The address, name, city, or region to be used in the search in free-form text format. For example, An optional parameter that indicates a preference for places that are closer to a specified position. If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude. For example, An optional parameter that limits the search results by returning only places that are within the provided bounding box. If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box. For example, A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. An optional parameter that limits the search results by returning only places that are in a specified list of countries. Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: The name of the place index resource you want to use for the search. The optional API key to authorize the request. An optional parameter. The maximum number of results returned per request. The default: The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for If you set the If the data provider does not have a value for Greek, the result will be in a language that the provider does support. An optional parameter. The maximum number of results returned per request. The default: A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. The address, name, city, or region to be used in the search in free-form text format. For example, The optional API key to authorize the request. A list of Places matching the input text. Each result contains additional information about the specific point of interest. Not all response properties are included with all responses. Some properties may only be returned by specific data partners. Contains a summary of the request. Echoes the input values for A list of Places matching the input text. Each result contains additional information about the specific point of interest. Not all response properties are included with all responses. Some properties may only be returned by specific data partners. The search text specified in the request. Contains the coordinates for the optional bias position specified in the request. This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude. For example, The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following: Esri Grab Here For more information about data providers, see Amazon Location Service data providers. Contains the coordinates for the optional bounding box specified in the request. The optional category filter specified in the request. Contains the optional country filter specified in the request. The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, Contains the optional result count limit specified in the request. The bounding box that fully contains all search results. If you specified the optional The search text specified in the request. The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following: Esri Grab Here For more information about data providers, see Amazon Location Service data providers. The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, The optional category filter specified in the request. A summary of the request sent by using The travel distance between the step's The estimated travel time, in seconds, from the step's The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg. The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg. The travel distance between the step's The estimated travel time, in seconds, from the step's Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is Included in the response for queries that set The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg. Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg. The height of the truck. For example, For routes calculated with a HERE resource, this value must be between 0 and 50 meters. The length of the truck. For example, For routes calculated with a HERE resource, this value must be between 0 and 300 meters. Specifies the unit of measurement for the truck dimensions. Default Value: The height of the truck. For example, For routes calculated with a HERE resource, this value must be between 0 and 50 meters. The width of the truck. For example, For routes calculated with a HERE resource, this value must be between 0 and 50 meters. Specifies the unit of measurement for the truck dimensions. Default Value: Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify Updates the description for the geofence collection. No longer used. If included, the only allowed value is This parameter is no longer used. Updates the description for the geofence collection. The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services. Format example: The name of the updated geofence collection. The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services. Format example: The time when the geofence collection was last updated in ISO 8601 format: The name of the API key resource to update. Updates the description for the API key resource. Updates the timestamp for when the API key resource will expire in ISO 8601 format: The boolean flag to be included for updating Must be set to Default value: The name of the API key resource to update. Whether the API key should expire. Set to The boolean flag to be included for updating Must be set to Default value: Updates the API key restrictions for the API key resource. Updates the parts of the map configuration that can be updated, including the political view. Updates the description for the map resource. The name of the map resource to update. No longer used. If included, the only allowed value is Updates the description for the map resource. Updates the parts of the map configuration that can be updated, including the political view. The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS. Format example: The name of the updated map resource. The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS. Format example: The timestamp for when the map resource was last updated in ISO 8601 format: Updates the data storage option for the place index resource. Updates the description for the place index resource. The name of the place index resource to update. No longer used. If included, the only allowed value is Updates the description for the place index resource. Updates the data storage option for the place index resource. The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across Amazon Web Services. Format example: The name of the updated place index resource. The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across Amazon Web Services. Format example: The timestamp for when the place index resource was last updated in ISO 8601 format: Updates the description for the route calculator resource. No longer used. If included, the only allowed value is Updates the description for the route calculator resource. The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS. Format example: The name of the updated route calculator resource. The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS. Format example: The timestamp for when the route calculator was last updated in ISO 8601 format: Updates the description for the tracker resource. Whether to enable position You do not need enable this feature to get Enables This parameter is only used if you are using a KMS customer managed key. Updates the position filtering for the tracker resource. Valid values: The name of the tracker resource to update. The name of the tracker resource to update. Updates the description for the tracker resource. Updates the position filtering for the tracker resource. Valid values: Whether to enable position You do not need enable this feature to get Enables This parameter is only used if you are using a KMS customer managed key. The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS. Format example: The name of the updated tracker resource. The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS. Format example: The timestamp for when the tracker resource was last updated in ISO 8601 format: The field where the invalid entry was detected. A message with the reason for the validation exception error. The field where the invalid entry was detected. The input failed to meet the constraints specified by the AWS service. A message with the reason for the validation exception error. The field name where the invalid entry was detected. A message with the reason for the validation exception error. The input failed to meet the constraints specified by the AWS service in a specified field. The name of the tracker resource to be associated with verification request. The device's state, including position, IP address, cell signals and Wi-Fi access points. The distance unit for the verification request. Default Value: The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points. The device identifier. The timestamp at which the device's position was determined. Uses ISO 8601 format: The timestamp for when the tracker resource received the device position in ISO 8601 format: The distance unit for the verification response. Medium access control address (Mac). Received signal strength (dBm) of the WLAN measurement data. Wi-Fi access point. \"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing\" Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket. You specify the value of the copy source in one of two formats, depending on whether you want to access the source object through an access point: For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region. Access points are not supported by directory buckets. Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format If your source bucket versioning is enabled, the If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3 generates in the Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. The key of the destination object. The model card associated with the model package. Since The model card associated with the model package. Since The model card associated with the model package. Since The model card associated with the model package. Since The content of the model card. The content of the model card. The content must follow the schema described in Model Package Model Card Schema. The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. The model card associated with the model package. Since The model card associated with the model package. Since Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts. Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads. By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions. Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants. Specifies configuration for a core dump from the model container when the process crashes. The model card associated with the model package. Since The model card associated with the model package. Since Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify For For For For For GCM (Firebase Cloud Messaging) using key credentials, there is no For GCM (Firebase Cloud Messaging) using token credentials, there is no For For You can use the returned Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify For ADM, For APNS and For APNS and For Baidu, For GCM (Firebase Cloud Messaging) using key credentials, there is no For GCM (Firebase Cloud Messaging) using token credentials, there is no For MPNS, For WNS, You can use the returned A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the The following attribute applies only to server-side encryption: The following attributes apply only to FIFO topics: By default, When you set (Optional) To override the generated value, you can specify a value for the A map of attributes with their corresponding values. The following lists names, descriptions, and values of the special request parameters that the The following attribute applies only to server-side encryption: The following attributes apply only to FIFO topics: By default, When you set (Optional) To override the generated value, you can specify a value for the A map of the subscription's attributes. Attributes in this map include the following: The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions: Permission to write to the Kinesis Data Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide. A map of the subscription's attributes. Attributes in this map include the following: The following attribute applies only to Amazon Data Firehose delivery stream subscriptions: Permission to write to the Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide. Response for GetSubscriptionAttributes action. Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long. Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses: The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions: Permission to write to the Kinesis Data Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses: The following attribute applies only to Amazon Data Firehose delivery stream subscriptions: Permission to write to the Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions: Permission to write to the Kinesis Data Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide. The following attributes apply only to FIFO topics: A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the The following attribute applies only to Amazon Data Firehose delivery stream subscriptions: Permission to write to the Firehose delivery stream Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide. The following attributes apply only to FIFO topics: Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters. Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with You can use The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. If you don't specify the You can use The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters. Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with If you don't specify the The message to send. The minimum size is one character. The maximum size is 256 KiB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. The message to send. The minimum size is one character. The maximum size is 256 KiB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters. Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone. Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time configuration uses the gateway's time zone. You can pass values for a complete maintenance schedule, or update policy, or both. Previous values will persist for whichever setting you choose not to modify. If an incomplete or invalid maintenance schedule is passed, the entire request will be rejected with an error and no changes will occur. A complete maintenance schedule must include values for both We recommend keeping maintenance updates turned on, except in specific use cases where the brief disruptions caused by updating the gateway could critically impact your deployment. Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance of the gateway. Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways. For information about configuring this setting using the Amazon Web Services console, see Setting a security level for your gateway in the Amazon S3 File Gateway User Guide. A higher security strategy level can affect performance of the gateway. The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month. The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31. A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway. A set of variables indicating the software update preferences for the gateway. Includes A JSON object containing the following fields: A JSON object containing the following fields: The type of security strategy that was specified for file gateway. The type of security strategy that was specified for file gateway. Indicates the automatic update policy for a gateway. A set of variables indicating the software update preferences for the gateway. Specifies the size of the gateway's metadata cache. Specifies the size of the gateway's metadata cache. This setting impacts gateway performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares in the Amazon S3 File Gateway User Guide. The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday. The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month. The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31. A set of variables indicating the software update preferences for the gateway. Includes A JSON object containing the following fields: A JSON object containing the following fields: Specifies the type of security strategy. ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only in S3 File Gateway. MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer. Specifies the type of security strategy. Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP). After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies. If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. To reference a user from this identity source in your Cedar policies, use the following syntax. IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId> Where Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP). After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store To reference a user from this identity source in your Cedar policies, refer to the following syntax examples. Amazon Cognito user pool: OpenID Connect (OIDC) provider: Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either At this time, Verified Permissions accepts tokens from only Amazon Cognito. Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature. If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either At this time, Verified Permissions accepts tokens from only Amazon Cognito. Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature. Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. The value of an attribute. Contains information about the runtime context for a request for which an authorization decision is made. This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations. The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source. The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions. This data type is used as a field that is part of an Configuration structure that is used as a parameter to CreateIdentitySource. Example: The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions. This data type part of a Configuration structure that is used as a parameter to CreateIdentitySource. Example: Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs. Example: Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. Example: Contains configuration information used when creating a new identity source. At this time, the only valid member of this structure is a Amazon Cognito user pool configuration. Specifies a This data type is used as a request parameter for the CreateIdentitySource operation. Contains configuration information used when creating a new identity source. This data type is used as a request parameter for the CreateIdentitySource operation. Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs. Example: Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. Example: Contains configuration information about an identity source. This data type is a response parameter to the GetIdentitySource operation. Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs. Example: Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. Example: Contains configuration information about an identity source. This data type is a response parameter to the ListIdentitySources operation. Specifies the details required to communicate with the identity provider (IdP) associated with this identity source. At this time, the only valid member of this structure is a Amazon Cognito user pool configuration. You must specify a Specifies the details required to communicate with the identity provider (IdP) associated with this identity source. The parents in the hierarchy that contains the entity. The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request. A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents. Contains information about an entity that can be referenced in a Cedar policy. This data type is used as one of the fields in the EntitiesDefinition structure. The claim that determines the principal in OIDC access tokens. For example, The access token The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource. The claim that determines the principal in OIDC access tokens. For example, The access token The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource. The claim that determines the principal in OIDC access tokens. For example, The access token The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources. The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. This data type is part of a Configuration structure, which is a parameter to CreateIdentitySource. The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. This data type is part of a ConfigurationDetail structure, which is a parameter to GetIdentitySource. The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. This data type is part of a ConfigurationItem structure, which is a parameter to ListIdentitySources. The token claim that you want Verified Permissions to interpret as group membership. For example, The policy store entity type that you want to map your users' group claim to. For example, The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource. The token claim that you want Verified Permissions to interpret as group membership. For example, The policy store entity type that you want to map your users' group claim to. For example, The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource. The token claim that you want Verified Permissions to interpret as group membership. For example, The policy store entity type that you want to map your users' group claim to. For example, The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySourcea. The claim that determines the principal in OIDC access tokens. For example, The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource. The claim that determines the principal in OIDC access tokens. For example, The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource. The claim that determines the principal in OIDC access tokens. For example, The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources. The OIDC configuration for processing access tokens. Contains allowed audience claims, for example The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource. The OIDC configuration for processing access tokens. Contains allowed audience claims, for example The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource. The OIDC configuration for processing access tokens. Contains allowed audience claims, for example The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySources. Contains configuration details of a Amazon Cognito user pool. Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. Contains an updated configuration to replace the configuration in an existing identity source. At this time, the only valid member of this structure is a Amazon Cognito user pool configuration. You must specify a Contains an update to replace the configuration in an existing identity source. The claim that determines the principal in OIDC access tokens. For example, The access token The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource. The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details. This data type is part of a UpdateConfiguration structure, which is a parameter to UpdateIdentitySource. The token claim that you want Verified Permissions to interpret as group membership. For example, The policy store entity type that you want to map your users' group claim to. For example, The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource. The claim that determines the principal in OIDC access tokens. For example, The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource. The OIDC configuration for processing access tokens. Contains allowed audience claims, for example The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source. This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.Using the AwsV4HttpSigner
+ * Using the AwsV4aHttpSigner
+ * AccountId.PrimaryEmail specified on the StartPrimaryEmailUpdate API call.PrimaryEmail from the StartPrimaryEmailUpdate API call.NJ) or the full state name (for example, New Jersey). This field is required in the following countries: US, CA, GB, DE, JP, IN, and BR.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId. It must call the operation in standalone context by not including the AccountId parameter.AccountId.lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.ListDomains in the Amazon Web Services Control Catalog API Reference.lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.ListDomains in the Amazon Web Services Control Catalog API Reference.lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.ListDomains in the Amazon Web Services Control Catalog API Reference.sourceSetUpOption, Audit Manager automatically infers and populates the correct value based on the sourceType that you specify.
"
},
"sourceKeyword":{"shape":"SourceKeyword"},
"sourceFrequency":{
@@ -2340,6 +2359,13 @@
"min":1,
"pattern":"^[a-zA-Z_0-9-\\s.,]+$"
},
+ "ControlState":{
+ "type":"string",
+ "enum":[
+ "ACTIVE",
+ "END_OF_SUPPORT"
+ ]
+ },
"ControlStatus":{
"type":"string",
"enum":[
@@ -2352,7 +2378,8 @@
"type":"string",
"enum":[
"Standard",
- "Custom"
+ "Custom",
+ "Core"
]
},
"Controls":{
@@ -2527,11 +2554,11 @@
},
"sourceSetUpOption":{
"shape":"SourceSetUpOption",
- "documentation":"AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, or MANUAL. Core_Control or a Common_Control.sourceSetUpOption, Audit Manager automatically infers and populates the correct value based on the sourceType that you specify.
"
},
"sourceKeyword":{"shape":"SourceKeyword"},
"sourceFrequency":{
@@ -2543,7 +2570,7 @@
"documentation":"AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, or MANUAL. Core_Control or a Common_Control.mappingID. mappingID. ListDomains in the Amazon Web Services Control Catalog API Reference.ListDomains in the Amazon Web Services Control Catalog API Reference.ListDomains , ListObjectives , and ListCommonControls .ListControls operation separately for each ARN. UNCATEGORIZED to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective.awsServices will show as empty.S3_OBJECT_VERSION_ID and S3_OBJECT_KEY types of source revisions, either of the types can be used independently, or they can be used together to override the source with a specific ObjectKey and VersionID.ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations.DirectPut as its source. StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations.DirectPut as its source. StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).V1 and V2. The default is V1.Enabled is set to true.True.True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.CreateFileSystem API operation:
CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
CREATING.CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.CreateFileSystem API operation:
CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
CREATING.CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.FileSystemId value to the DeleFileSystem operation.FileSystemId value to the DeleFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).FileSystemId value to the DeleteFileSystem operation.FileSystemId value to the DeleteFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).
AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity StorageType ThroughputCapacity DiskIopsConfiguration WeeklyMaintenanceStartTime
AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType LogConfiguration LustreRootSquashConfiguration PerUnitStorageThroughput StorageCapacity WeeklyMaintenanceStartTime
AddRouteTableIds AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword HAPairs RemoveRouteTableIds StorageCapacity ThroughputCapacity ThroughputCapacityPerHAPair WeeklyMaintenanceStartTime
"
+ "documentation":"AddRouteTableIds AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime DiskIopsConfiguration RemoveRouteTableIds StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime
AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity StorageType ThroughputCapacity DiskIopsConfiguration WeeklyMaintenanceStartTime
AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType LogConfiguration LustreRootSquashConfiguration MetadataConfiguration PerUnitStorageThroughput StorageCapacity WeeklyMaintenanceStartTime
AddRouteTableIds AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword HAPairs RemoveRouteTableIds StorageCapacity ThroughputCapacity ThroughputCapacityPerHAPair WeeklyMaintenanceStartTime
"
},
"UpdateSharedVpcConfiguration":{
"name":"UpdateSharedVpcConfiguration",
@@ -1718,7 +1719,7 @@
},
"DeploymentType":{
"shape":"LustreDeploymentType",
- "documentation":"AddRouteTableIds AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime DiskIopsConfiguration RemoveRouteTableIds StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide. SCRATCH_1)SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). You can optionally specify a metadata configuration mode for PERSISTENT_2 which supports increasing metadata performance. PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.SCRATCH_1)PERSISTENT_2 deployment type.
AutoImportPolicy ExportPath ImportedFileChunkSize ImportPath 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.PERSISTENT_2 deployment type.
"
+ }
+ },
+ "documentation":"PERSISTENT_2 deployment type. The configuration uses a Metadata IOPS value to set the maximum rate of metadata disk IOPS supported by the file system.StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
"
+ "documentation":"HAPairs is less than 1 or greater than 12.HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
"
},
"ThroughputCapacityPerHAPair":{
"shape":"ThroughputCapacityPerHAPair",
@@ -1867,11 +1887,11 @@
},
"StorageCapacity":{
"shape":"StorageCapacity",
- "documentation":"HAPairs is less than 1 or greater than 12.HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.StorageType and the Lustre DeploymentType, as follows:
SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs. StorageType as follows:
"
+ "documentation":"StorageType and the Lustre DeploymentType, as follows:
SCRATCH_2, PERSISTENT_2, and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs. StorageType as follows:
"
},
"StorageType":{
"shape":"StorageType",
- "documentation":"SSD and HDD.
SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types. SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide. SSD and HDD.
SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide. 2.10, 2.12, and 2.15:
2.12 or 2.15 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.2.10, 2.12, and 2.15:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.2.12 is supported by all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.2.15 is supported by all Lustre deployment types and is recommended for all new file systems.2.10, except for the following deployments:
"
},
"OpenZFSConfiguration":{
"shape":"CreateFileSystemOpenZFSConfiguration",
@@ -1975,7 +1995,7 @@
},
"SecurityStyle":{
"shape":"SecurityStyle",
- "documentation":"2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode.
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
RW specifies a read/write volume. RW is the default.DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
RW specifies a read/write volume. RW is the default.DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
"
+ "documentation":"UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
"
}
}
},
@@ -3487,7 +3507,7 @@
},
"DataRepositoryPath":{
"shape":"ArchivePath",
- "documentation":"UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
"
+ "documentation":"
DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.s3://myBucket/myPrefix/.
"
},
"DataRepositorySubdirectories":{
"shape":"SubDirectoriesPaths",
@@ -3756,6 +3776,21 @@
"MISCONFIGURED_UNAVAILABLE"
]
},
+ "FileSystemLustreMetadataConfiguration":{
+ "type":"structure",
+ "required":["Mode"],
+ "members":{
+ "Iops":{
+ "shape":"MetadataIops",
+ "documentation":"
DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nfs://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.s3://myBucket/myPrefix/.1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.
"
+ }
+ },
+ "documentation":"PERSISTENT_2 deployment type. The configuration enables the file system to support increasing metadata performance.PERSISTENT_2 deployment type.OrganizationalUnitDistinguishedName.OrganizationalUnitDistinguishedName.
PERSISTENT_1 SSD-based deployment types, valid values are 50, 100, and 200 MB/s/TiB.PERSISTENT_2 SSD-based deployment types, valid values are 125, 250, 500, and 1000 MB/s/TiB.PERSISTENT_2 deployment type. When this configuration is enabled, the file system supports increasing metadata performance.UpdateFileSystem operation.1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.PERSISTENT_2 deployment type.
"
+ }
+ },
+ "documentation":"USER_PROVISIONED as the value for this parameter. Then use the Iops parameter to provide a Metadata IOPS value that is greater than or equal to the current number of Metadata IOPS provisioned for the file system.AUTOMATIC as the value for this parameter, but do not input a value for Iops.PERSISTENT_2 deployment type. You can request an increase in your file system's Metadata IOPS and/or switch your file system's metadata configuration mode. For more information, see Managing metadata performance in the Amazon FSx for Lustre User Guide.AUTHORIZATION_CODE grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.AUTHORIZATION_CODE grant type workflow.SecurityGroup, that are needed to make this connection successfully.SecurityGroup, that are needed to make this connection successfully.READY, IN_PROGRESS, or FAILED.
JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).JDBC Connections use the following ConnectionParameters.
HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.USERNAME, PASSWORD) or SECRET_ID.JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.KAFKA - Designates a connection to an Apache Kafka streaming platform.KAFKA Connections use the following ConnectionParameters.
KAFKA_BOOTSTRAP_SERVERS.KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.MONGODB - Designates a connection to a MongoDB document database.MONGODB Connections use the following ConnectionParameters.
CONNECTION_URL.USERNAME, PASSWORD) or SECRET_ID.NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE Connections use the following ConnectionParameters.
CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.SFTP is not supported.
JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).JDBC Connections use the following ConnectionParameters.
HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.USERNAME, PASSWORD) or SECRET_ID.JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.KAFKA - Designates a connection to an Apache Kafka streaming platform.KAFKA Connections use the following ConnectionParameters.
KAFKA_BOOTSTRAP_SERVERS.KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.MONGODB - Designates a connection to a MongoDB document database.MONGODB Connections use the following ConnectionParameters.
CONNECTION_URL.USERNAME, PASSWORD) or SECRET_ID.SALESFORCE - Designates a connection to Salesforce using OAuth authencation.
AuthenticationConfiguration member to be configured.NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE Connections use the following ConnectionParameters.
CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.SFTP is not supported.SecurityGroup, that are needed to successfully make this connection.SecurityGroup, that are needed to successfully make this connection.TIMEOUT status. The default is 2,880 minutes (48 hours).TIMEOUT status. The default is 2,880 minutes (48 hours) for batch jobs.TIMEOUT status. The default is 2,880 minutes (48 hours).TIMEOUT status. The default is 2,880 minutes (48 hours) for batch jobs.JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.TIMEOUT status. The default is 2,880 minutes (48 hours).TIMEOUT status. The default is 2,880 minutes (48 hours) for batch jobs.USER_MANAGED.AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.GET request.AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.AWS_MANAGED or USER_MANAGED.GET request.AUTHORIZATION_CODE grant type.JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job. TableIdentifier structure that describes a target table for resource linking.ViewOriginalText to ViewExpandedText. For example:
"
+ "documentation":"SELECT * from table1 → SELECT * from db1.table1 ViewOriginalText to ViewExpandedText. For example:
"
+ },
+ "ValidationConnection":{
+ "shape":"NameString",
+ "documentation":"SELECT * from table1 -> SELECT * from db1.table1 ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.IDLE: If a device is inside of a geofence, and the device is not moving.
geo:GetMap* - Allows all actions needed for map rendering.
geo:SearchPlaceIndexForText - Allows geocoding.geo:SearchPlaceIndexForPosition - Allows reverse geocoding.geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.GetPlace - Allows finding a place by place ID.
geo:CalculateRoute - Allows point to point routing.geo:CalculateRouteMatrix - Allows calculating a matrix of routes.geo:GetMap* as an input to the list. [\"geo:GetMap*\"] is valid but [\"geo:GetMapTile\"] is not. Similarly, you cannot use [\"geo:SearchPlaceIndexFor*\"] - you must list each of the Place actions separately.
"
- },
"AllowResources":{
"shape":"ApiKeyRestrictionsAllowResourcesList",
"documentation":"$\\-._+!*`(),;/?:@=& https://example.com.
partition, region, and account-id as the key that is being created.arn, partition, service, region, account-id and resource-id delimited by colons (:).arn:aws:geo:region:account-id:map/ExampleMap*.
"
}
},
"documentation":"$\\-._+!*`(),;/?:@=& https://example.com.
"
- },
"TrackerName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
"
}
}
},
@@ -1249,6 +1287,12 @@
"members":{
}
},
+ "Base64EncodedGeobuf":{
+ "type":"blob",
+ "max":600000,
+ "min":0,
+ "sensitive":true
+ },
"BatchDeleteDevicePositionHistoryError":{
"type":"structure",
"required":[
@@ -1271,19 +1315,19 @@
"BatchDeleteDevicePositionHistoryRequest":{
"type":"structure",
"required":[
- "DeviceIds",
- "TrackerName"
+ "TrackerName",
+ "DeviceIds"
],
"members":{
- "DeviceIds":{
- "shape":"BatchDeleteDevicePositionHistoryRequestDeviceIdsList",
- "documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
"
- },
"TrackerName":{
"shape":"ResourceName",
"documentation":"“DeviceIds” : [DeviceId1,DeviceId2]
"
}
}
},
@@ -1306,17 +1350,17 @@
"BatchDeleteGeofenceError":{
"type":"structure",
"required":[
- "Error",
- "GeofenceId"
+ "GeofenceId",
+ "Error"
],
"members":{
- "Error":{
- "shape":"BatchItemError",
- "documentation":"“DeviceIds” : [DeviceId1,DeviceId2] YYYY-MM-DDThh:mm:ss.sssZ
"
- },
"TrackerName":{
"shape":"BatchGetDevicePositionRequestTrackerNameString",
"documentation":"device-ids=DeviceId1&device-ids=DeviceId2
"
}
}
},
@@ -1472,22 +1516,22 @@
"BatchGetDevicePositionRequestTrackerNameString":{
"type":"string",
"min":1,
- "pattern":"^[-._\\w]+$"
+ "pattern":"[-._\\w]+"
},
"BatchGetDevicePositionResponse":{
"type":"structure",
"required":[
- "DevicePositions",
- "Errors"
+ "Errors",
+ "DevicePositions"
],
"members":{
- "DevicePositions":{
- "shape":"DevicePositionList",
- "documentation":"device-ids=DeviceId1&device-ids=DeviceId2 \"key\" : \"value\" YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ. Car, such as avoiding routes that use ferries or tolls.TravelMode must be specified as Car.DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.false false | true [longitude, latitude]. For example, [-123.115, 49.285].SnappedDeparturePositions.[-180 to 180,-90 to 90] [longitude, latitude]. For example, [-122.339, 47.615] SnappedDestinationPositions.[-180 to 180,-90 to 90] TravelMode you specify also determines how you specify route preferences:
Car use the CarModeOptions parameter.Truck use the TruckModeOptions parameter.Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.Truck is not available for Grab.Car DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.400 ValidationException error.
"
},
- "DestinationPositions":{
- "shape":"CalculateRouteMatrixRequestDestinationPositionsList",
- "documentation":"YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00 [longitude, latitude]. For example, [-122.339, 47.615] SnappedDestinationPositions.[-180 to 180,-90 to 90] DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.false false | true Kilometers Car, such as avoiding routes that use ferries or tolls.TravelMode must be specified as Car.Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.TravelMode must be specified as Truck.TravelMode you specify also determines how you specify route preferences:
Car use the CarModeOptions parameter.Truck use the TruckModeOptions parameter.Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.Truck is not available for Grab.Car Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.TravelMode must be specified as Truck.
Esri Grab Here DeparturePositions multiplied by the number of DestinationPositions.DeparturePositions multiplied by the number of DestinationPositions.Car, such as avoiding routes that use ferries or tolls.TravelMode must be specified as Car.false false | true [longitude, latitude].
[-123.115, 49.285] 400 RoutesValidationException error.[-180 to 180,-90 to 90] [longitude, latitude].
[-122.339, 47.615] [-180 to 180,-90 to 90]
DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]] 400 ValidationException error.400 RoutesValidationException error.[-180 to 180,-90 to 90] Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.Truck is not available for Grab.TravelMode you specify also determines how you specify route preferences:
Car use the CarModeOptions parameter.Truck use the TruckModeOptions parameter.Car
"
},
- "DestinationPosition":{
- "shape":"Position",
- "documentation":"YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00 [longitude, latitude].
[-122.339, 47.615] [-180 to 180,-90 to 90] false false | true false false | true Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.Truck is not available for Grab.TravelMode you specify also determines how you specify route preferences:
Car use the CarModeOptions parameter.Truck use the TruckModeOptions parameter.Car Car, such as avoiding routes that use ferries or tolls.TravelMode must be specified as Car.Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.TravelMode must be specified as Truck.
DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]] 400 ValidationException error.400 RoutesValidationException error.[-180 to 180,-90 to 90] [min x, min y, max x, max y].bbox parameters describe the lower southwest corner:
bbox position is the X coordinate or longitude of the lower southwest corner. bbox position is the Y coordinate or latitude of the lower southwest corner. bbox parameters describe the upper northeast corner:
"
+ },
+ "DataSource":{
+ "shape":"String",
"documentation":"bbox position is the X coordinate, or longitude of the upper northeast corner. bbox position is the Y coordinate, or latitude of the upper northeast corner.
Esri Grab Here 400 RoutesValidationException error.[min x, min y, max x, max y].bbox parameters describe the lower southwest corner:
bbox position is the X coordinate or longitude of the lower southwest corner. bbox position is the Y coordinate or latitude of the lower southwest corner. bbox parameters describe the upper northeast corner:
"
+ "DistanceUnit":{
+ "shape":"DistanceUnit",
+ "documentation":"bbox position is the X coordinate, or longitude of the upper northeast corner. bbox position is the Y coordinate, or latitude of the upper northeast corner. TravelMode as Truck.
"
},
- "Description":{
- "shape":"ResourceDescription",
- "documentation":"ExampleGeofenceCollection.RequestBasedUsage.\"key\" : \"value\"
"
+ },
+ "KmsKeyId":{
+ "shape":"KmsKeyId",
+ "documentation":"
"
- },
"CollectionName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
"
+ },
"CreateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection YYYY-MM-DDThh:mm:ss.sssZ
"
+ },
+ "Restrictions":{
+ "shape":"ApiKeyRestrictions",
+ "documentation":"ExampleAPIKey.YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.
"
- },
"NoExpiry":{
"shape":"Boolean",
"documentation":"ExampleAPIKey.true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.\"key\" : \"value\"
"
@@ -2169,16 +2226,12 @@
"CreateKeyResponse":{
"type":"structure",
"required":[
- "CreateTime",
"Key",
"KeyArn",
- "KeyName"
+ "KeyName",
+ "CreateTime"
],
"members":{
- "CreateTime":{
- "shape":"Timestamp",
- "documentation":"YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.
"
},
+ "Configuration":{
+ "shape":"MapConfiguration",
+ "documentation":"ExampleMap.MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.RequestBasedUsage.\"key\" : \"value\"
"
@@ -2227,54 +2284,54 @@
"CreateMapResponse":{
"type":"structure",
"required":[
- "CreateTime",
+ "MapName",
"MapArn",
- "MapName"
+ "CreateTime"
],
"members":{
- "CreateTime":{
- "shape":"Timestamp",
- "documentation":"YYYY-MM-DDThh:mm:ss.sssZ.
"
},
- "MapName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:map/ExampleMap YYYY-MM-DDThh:mm:ss.sssZ.HERE returns an error.
Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
"
},
+ "DataSource":{
+ "shape":"String",
+ "documentation":"ExamplePlaceIndex.HERE returns an error.
Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.RequestBasedUsage.\"key\" : \"value\"
"
@@ -2284,22 +2341,22 @@
"CreatePlaceIndexResponse":{
"type":"structure",
"required":[
- "CreateTime",
+ "IndexName",
"IndexArn",
- "IndexName"
+ "CreateTime"
],
"members":{
- "CreateTime":{
- "shape":"Timestamp",
- "documentation":"YYYY-MM-DDThh:mm:ss.sssZ.
"
},
- "IndexName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex YYYY-MM-DDThh:mm:ss.sssZ. HERE returns an error.
Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.RequestBasedUsage.
\"tag1\" : \"value1\", \"tag2\" : \"value2\"}\"key\" : \"value\"
"
@@ -2337,19 +2394,19 @@
"CreateRouteCalculatorResponse":{
"type":"structure",
"required":[
- "CalculatorArn",
"CalculatorName",
+ "CalculatorArn",
"CreateTime"
],
"members":{
- "CalculatorArn":{
- "shape":"GeoArn",
- "documentation":"
"
- },
"CalculatorName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
"
},
+ "CalculatorArn":{
+ "shape":"GeoArn",
+ "documentation":"ExampleRouteCalculator.
"
+ },
"CreateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:route-calculator/ExampleCalculator YYYY-MM-DDThh:mm:ss.sssZ.
"
@@ -2360,25 +2417,9 @@
"type":"structure",
"required":["TrackerName"],
"members":{
- "Description":{
- "shape":"ResourceDescription",
- "documentation":"2020–07-2T12:15:20.000Z+01:00 UPDATE events from this tracker to be sent to EventBridge.ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.
TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations. TimeBased.
"
},
"PricingPlan":{
"shape":"PricingPlan",
@@ -2386,41 +2427,57 @@
"deprecated":true,
"deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage."
},
+ "KmsKeyId":{
+ "shape":"KmsKeyId",
+ "documentation":"ExampleTracker.\"key\" : \"value\"
"
},
- "TrackerName":{
- "shape":"ResourceName",
- "documentation":"
"
+ "PositionFiltering":{
+ "shape":"PositionFiltering",
+ "documentation":"ExampleTracker.
TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations. TimeBased.UPDATE events from this tracker to be sent to EventBridge.ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.YYYY-MM-DDThh:mm:ss.sssZ.
"
},
- "TrackerName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:tracker/ExampleTracker YYYY-MM-DDThh:mm:ss.sssZ. true to delete the key or to false to not preemptively delete the API key.true, or false.true to delete the key or to false to not preemptively delete the API key.true, or false.
"
- },
"CollectionName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection YYYY-MM-DDThh:mm:ss.sssZ
"
+ },
+ "Description":{
"shape":"ResourceDescription",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection RequestBasedUsage.YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ.
"
},
- "MapName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:map/ExampleMap RequestBasedUsage.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.
Esri Grab Here
"
},
- "IndexName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex RequestBasedUsage.YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ.
Esri Grab Here
"
},
- "CalculatorName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:route-calculator/ExampleCalculator RequestBasedUsage.YYYY-MM-DDThh:mm:ss.sssZ.
"
},
+ "UpdateTime":{
+ "shape":"Timestamp",
+ "documentation":"2020–07-2T12:15:20.000Z+01:00 YYYY-MM-DDThh:mm:ss.sssZ.
"
+ },
"DataSource":{
"shape":"String",
"documentation":"2020–07-2T12:15:20.000Z+01:00
Esri Grab Here RequestBasedUsage.YYYY-MM-DDThh:mm:ss.sssZ.
"
}
}
},
@@ -2888,37 +2945,25 @@
"DescribeTrackerResponse":{
"type":"structure",
"required":[
- "CreateTime",
- "Description",
- "TrackerArn",
"TrackerName",
+ "TrackerArn",
+ "Description",
+ "CreateTime",
"UpdateTime"
],
"members":{
- "CreateTime":{
- "shape":"Timestamp",
- "documentation":"2020–07-2T12:15:20.000Z+01:00 YYYY-MM-DDThh:mm:ss.sssZ.
"
},
"Description":{
"shape":"ResourceDescription",
"documentation":"arn:aws:geo:region:account-id:tracker/ExampleTracker UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.RequestBasedUsage.
"
- },
- "TrackerName":{
- "shape":"ResourceName",
- "documentation":"arn:aws:geo:region:account-id:tracker/ExampleTracker YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ [X or longitude, Y or latitude].\"key\" : \"value\" YYYY-MM-DDThh:mm:ss.sssZ. [X or longitude, Y or latitude].\"key\" : \"value\" YYYY-MM-DDThh:mm:ss.sssZ
",
- "location":"uri",
- "locationName":"ConsumerArn"
- },
"TrackerName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
",
+ "location":"uri",
+ "locationName":"ConsumerArn"
}
}
},
@@ -3063,53 +3160,220 @@
"type":"double",
"box":true
},
+ "Earfcn":{
+ "type":"integer",
+ "max":262143,
+ "min":0
+ },
+ "EutranCellId":{
+ "type":"integer",
+ "max":268435455,
+ "min":0
+ },
"FilterPlaceCategoryList":{
"type":"list",
"member":{"shape":"PlaceCategory"},
"max":5,
"min":1
},
+ "ForecastGeofenceEventsDeviceState":{
+ "type":"structure",
+ "required":["Position"],
+ "members":{
+ "Position":{
+ "shape":"Position",
+ "documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour. Kilometers DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.KilometersPerHour.null 20 ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.IDLE: If a device is inside of a geofence, and the device is not moving.YYYY-MM-DDThh:mm:ss.sssZ [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).[[double, double], ...]).[[[double, double], ...], ...]).[longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).[[double, double], ...]).[[[double, double], ...], ...]).YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.
"
- },
- "MaxResults":{
- "shape":"GetDevicePositionHistoryRequestMaxResultsInteger",
- "documentation":"EndTimeExclusive must be after the time for StartTimeInclusive.100 null YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.
"
},
- "TrackerName":{
- "shape":"ResourceName",
- "documentation":"StartTimeInclusive must be before EndTimeExclusive.YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.
"
+ },
+ "MaxResults":{
+ "shape":"GetDevicePositionHistoryRequestMaxResultsInteger",
+ "documentation":"EndTimeExclusive must be after the time for StartTimeInclusive.100 YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ \"key\" : \"value\"
"
},
+ "CreateTime":{
+ "shape":"Timestamp",
+ "documentation":"ACTIVE — The geofence has been indexed by the system. PENDING — The geofence is being processed by the system.FAILED — The geofence failed to be indexed by the system.DELETED — The geofence has been deleted from the system index.DELETING — The geofence is being deleted from the system index.YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ \"key\" : \"value\" Noto Sans Regular, Arial Unicode.
Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic Arial Regular | Arial Italic | Arial Bold Arial Regular | Arial Italic | Arial Bold | Arial Unicode MS Bold | Arial Unicode MS Regular
Fira GO Regular | Fira GO Bold Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular
Noto Sans Regular | Noto Sans Medium | Noto Sans Bold
Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.Noto Sans Regular, Arial Unicode.
Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic Arial Regular | Arial Italic | Arial Bold Arial Regular | Arial Italic | Arial Bold
Fira GO Regular | Fira GO Bold Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular
Noto Sans Regular | Noto Sans Medium | Noto Sans Bold
Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.application/octet-stream.
sprites.png sprites@2x.png for high pixel density displays
",
"location":"uri",
"locationName":"FileName"
},
- "Key":{
- "shape":"ApiKey",
- "documentation":"sprites.json sprites@2x.json for high pixel density displaysimage/png, and the sprite offset JSON document is application/json. application/json.application/vnd.mapbox-vector-tile.
",
- "location":"uri",
- "locationName":"PlaceId"
+ "Key":{
+ "shape":"ApiKey",
+ "documentation":"
place.result_type field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.[longitude,latitude].StartPosition isn't located on a road, it's snapped to a nearby road. [longitude,latitude].EndPosition isn't located on a road, it's snapped to a nearby road. StartPosition and EndPosition along a calculated route.
"
@@ -3589,18 +3891,10 @@
"shape":"LegDurationSecondsDouble",
"documentation":"Kilometers unless the request specifies a DistanceUnit of Miles.StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.[longitude,latitude].EndPosition isn't located on a road, it's snapped to a nearby road. [longitude,latitude].StartPosition isn't located on a road, it's snapped to a nearby road. null YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ \"key\" : \"value\"
"
},
+ "CreateTime":{
+ "shape":"Timestamp",
+ "documentation":"ACTIVE — The geofence has been indexed by the system. PENDING — The geofence is being processed by the system.FAILED — The geofence failed to be indexed by the system.DELETED — The geofence has been deleted from the system index.DELETING — The geofence is being deleted from the system index.YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ \"key\" : \"value\" null 100 null Active or Expired API keys.100 null Active or Expired API keys.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.YYYY-MM-DDThh:mm:ss.sssZ.
Esri Grab Here
Esri Grab Here YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ.
"
+ "Description":{
+ "shape":"ResourceDescription",
+ "documentation":"2020–07-2T12:15:20.000Z+01:00
Esri Grab Here RequestBasedUsage.YYYY-MM-DDThh:mm:ss.sssZ.
"
+ },
"UpdateTime":{
"shape":"Timestamp",
"documentation":"2020–07-2T12:15:20.000Z+01:00 YYYY-MM-DDThh:mm:ss.sssZ.
"
@@ -4212,6 +4506,12 @@
"type":"structure",
"required":["TrackerName"],
"members":{
+ "TrackerName":{
+ "shape":"ResourceName",
+ "documentation":"2020–07-2T12:15:20.000Z+01:00 100 null YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ. POI layer for the VectorEsriNavigation style. Default is unset.VectorEsriNavigation supports CustomLayers. For more information, see Custom Layers.
VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content. RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide. VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content. VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets – The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin has been deprecated, but will continue to work in applications that use it.VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite – A global map containing high resolution satellite imagery.HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.ap-southeast-1). For more information, see GrabMaps countries and area covered.
"
},
"PoliticalView":{
"shape":"CountryCode3",
"documentation":"VectorOpenDataStandardLight – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.VectorOpenDataVisualizationLight – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.IND for the Indian view.
VectorEsriNavigation – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices. It also includes a richer set of places, such as shops, services, restaurants, attractions, and other points of interest. Enable the POI layer by setting it in CustomLayers to leverage the additional places data.RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide. VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content. VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets – The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.RasterHereExploreSatellite – A global map containing high resolution satellite imagery.HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin has been deprecated, but will continue to work in applications that use it.VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.ap-southeast-1). For more information, see GrabMaps countries and area covered.
"
+ "CustomLayers":{
+ "shape":"CustomLayerList",
+ "documentation":"VectorOpenDataStandardLight – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.VectorOpenDataVisualizationLight – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.unset.POI layer for the VectorEsriNavigation style. Default is unset.VectorEsriNavigation supports CustomLayers. For more information, see Custom Layers.IND for the Indian view.unset.123 Any Street, Any Town, USA.CAN.True if the result is interpolated from other known places.False if the Place is a known place.False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses. Main Street.123 Any Street, Any Town, USA.Downtown.Toronto.Downtown.Metro Vancouver.British Columbia.Main Street.Blissville is a submunicipality in the Queen County in New York.district.CAN.Metro Vancouver.True if the result is interpolated from other known places.False if the Place is a known place.False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses. Place is located. Returned only when using HERE or Grab as the selected partner.UnitNumber, the type of unit. For example, Apartment.3B or Unit 123.SearchPlaceIndexForPosition.3B or Unit 123.SearchPlaceIndexForPosition.UnitNumber, the type of unit. For example, Apartment.Blissville is a submunicipality in the Queen County in New York.district, and the OpenData property is borough.\"key\" : \"value\" YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ GetPlace operation to find the place again later.SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.GetPlace operation to find the place again later, or to get full information for the Place.GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
"
+ "documentation":"
place.result_type field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.GetPlace operation to find the place again later, or to get full information for the Place.GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.Distance will be returned only if a bias position was specified in the query.GetPlace operation to find the place again later.SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.Distance will be returned only if a bias position was specified in the query.GetPlace operation to find the place again later.SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.en for English.language parameter set to en. The city in the results will most likely be returned as Athens.language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.[-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.50 [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.en for English.language parameter set to en. The city in the results will most likely be returned as Athens.language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.Position, Language, MaxResults, and the DataSource of the place index. 50
en for English.50 SearchPlaceIndexForPosition.eiffel tow.[-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error. [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
"
},
- "IndexName":{
- "shape":"ResourceName",
- "documentation":"AUS.5 en for English.Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.5 eiffel tow.BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index. [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
en for English.
en for English.SearchPlaceIndexForSuggestions.123 Any Street.[-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error. [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
"
},
- "IndexName":{
- "shape":"ResourceName",
- "documentation":"AUS.50 en for English.Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.50 123 Any Street.BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results. [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
en for English.FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.
en for English.SearchPlaceIndexForText.StartPosition and EndPosition.StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.StartPosition and EndPosition.StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.0. IncludeLegGeometry to True.
4.5.
15.5.Meters
4.5.
4.5.Meters TravelMode as Truck.RequestBasedUsage.
"
- },
"CollectionName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
"
+ },
"UpdateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection YYYY-MM-DDThh:mm:ss.sssZ YYYY-MM-DDThh:mm:ss.sssZ. ExpireTime or Restrictions details.true to update an API key resource that has been used in the past 7 days.False if force update is not preferredFalse true to set the API key to have no expiration time.ExpireTime or Restrictions details.true to update an API key resource that has been used in the past 7 days.False if force update is not preferredFalse RequestBasedUsage.
"
- },
"MapName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:map/ExampleMap
"
+ },
"UpdateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:map/ExampleMap YYYY-MM-DDThh:mm:ss.sssZ. RequestBasedUsage.
"
- },
"IndexName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex
"
+ },
"UpdateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex YYYY-MM-DDThh:mm:ss.sssZ. RequestBasedUsage.
"
- },
"CalculatorName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:route- calculator/ExampleCalculator
"
+ },
"UpdateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:route- calculator/ExampleCalculator YYYY-MM-DDThh:mm:ss.sssZ. UPDATE events from this tracker to be sent to EventBridge.ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
"
+ "TrackerName":{
+ "shape":"ResourceName",
+ "documentation":"TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.
"
+ },
+ "EventBridgeEnabled":{
+ "shape":"Boolean",
+ "documentation":"TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations. UPDATE events from this tracker to be sent to EventBridge.ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
"
- },
"TrackerName":{
"shape":"ResourceName",
"documentation":"arn:aws:geo:region:account-id:tracker/ExampleTracker
"
+ },
"UpdateTime":{
"shape":"Timestamp",
"documentation":"arn:aws:geo:region:account-id:tracker/ExampleTracker YYYY-MM-DDThh:mm:ss.sssZ. Kilometers YYYY-MM-DDThh:mm:ss.sssZ. YYYY-MM-DDThh:mm:ss.sssZ.
reports/january.pdf from the general purpose bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3, use awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded.arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded. x-amz-copy-source header by default identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId query parameter. Specifically, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.x-amz-version-id response header in the response.x-amz-version-id response header is always null.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model card associated with the model package, see View the Details of a Model Version.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model card associated with the model package, see View the Details of a Model Version.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
"
}
},
- "documentation":"Draft: The model card is a work in progress.PendingReview: The model card is pending review.Approved: The model card is approved.Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model card associated with the model package, see View the Details of a Model Version.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model card associated with the model package, see View the Details of a Model Version.ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.PlatformPrincipal and PlatformCredential are received from the notification service.
ADM, PlatformPrincipal is client id and PlatformCredential is client secret.Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.PlatformPrincipal. The PlatformCredential is API key.PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.PlatformPrincipal and PlatformCredential are received from the notification service.
PlatformPrincipal is client id and PlatformCredential is client secret.APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.PlatformPrincipal is API key and PlatformCredential is secret key.PlatformPrincipal. The PlatformCredential is API key.PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.PlatformPrincipal is TLS certificate and PlatformCredential is private key.PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.DisplayName – The display name to use for a topic with SMS subscriptions.FifoTopic – Set to true to create a FIFO topic.Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
"
+ "documentation":"ArchivePolicy – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).MessageDeduplicationId parameter for the Publish action.CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.DisplayName – The display name to use for a topic with SMS subscriptions.FifoTopic – Set to true to create a FIFO topic.Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
"
},
"Tags":{
"shape":"TagList",
@@ -1339,7 +1341,7 @@
"members":{
"Attributes":{
"shape":"SubscriptionAttributesMap",
- "documentation":"ArchivePolicy – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).MessageDeduplicationId parameter for the Publish action.
ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.DeliveryPolicy – The JSON serialization of the subscription's delivery policy.EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.Owner – The Amazon Web Services account ID of the subscription's owner.PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.SubscriptionArn – The subscription's ARN.TopicArn – The topic ARN that the subscription is associated with.
"
+ "documentation":"SubscriptionRoleArn – The ARN of the IAM role that has the following:
ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.DeliveryPolicy – The JSON serialization of the subscription's delivery policy.EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.Owner – The Amazon Web Services account ID of the subscription's owner.PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.SubscriptionArn – The subscription's ARN.TopicArn – The topic ARN that the subscription is associated with.
"
}
},
"documentation":"SubscriptionRoleArn – The ARN of the IAM role that has the following:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
"
+ "documentation":"SubscriptionRoleArn – The ARN of the IAM role that has the following:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
"
},
"AttributeValue":{
"shape":"attributeValue",
@@ -2353,7 +2355,7 @@
},
"Attributes":{
"shape":"SubscriptionAttributesMap",
- "documentation":"SubscriptionRoleArn – The ARN of the IAM role that has the following:
Subscribe action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionRoleArn – The ARN of the IAM role that has the following:
"
+ "documentation":"ReplayPolicy – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.ReplayStatus – Retrieves the status of the subscription message replay, which can be one of the following:
Completed – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy then the subscription will no longer receive newly published messages.In progress – The replay is currently replaying the selected messages.Failed – The replay was unable to complete.Pending – The default state while the replay initiates.Subscribe action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionRoleArn – The ARN of the IAM role that has the following:
"
},
"ReturnSubscriptionArn":{
"shape":"boolean",
diff --git a/services/sqs/pom.xml b/services/sqs/pom.xml
index 66051eb2f5a7..4f03deaaf49c 100644
--- a/services/sqs/pom.xml
+++ b/services/sqs/pom.xml
@@ -21,7 +21,7 @@
ReplayPolicy – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.ReplayStatus – Retrieves the status of the subscription message replay, which can be one of the following:
Completed – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy then the subscription will no longer receive newly published messages.In progress – The replay is currently replaying the selected messages.Failed – The replay was unable to complete.Pending – The default state while the replay initiates.#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.200.#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.200.#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.MinuteOfHour and HourOfDay, and either DayOfMonth or DayOfWeek.AutomaticUpdatePolicy field with the following inputs:ALL_VERSIONS - Enables regular gateway maintenance updates.EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
"
+ "documentation":"
"
+ "documentation":"ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.MandatorySigning: If you use this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later. MandatoryEncryption: If you use this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.EnforceEncryption: If you use this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.
"
},
"FileSharesVisible":{
"shape":"Boolean",
@@ -4948,6 +4961,16 @@
"type":"string",
"pattern":"\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z"
},
+ "SoftwareUpdatePreferences":{
+ "type":"structure",
+ "members":{
+ "AutomaticUpdatePolicy":{
+ "shape":"AutomaticUpdatePolicy",
+ "documentation":"ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later. MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.ALL_VERSIONS - Enables regular gateway maintenance updates.EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.AutomaticUpdatePolicy field with the following inputs:ALL_VERSIONS - Enables regular gateway maintenance updates.EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
"
+ "documentation":"
"
},
"UpdateMaintenanceStartTimeOutput":{
"type":"structure",
@@ -5796,7 +5819,7 @@
"GatewayARN":{"shape":"GatewayARN"},
"SMBSecurityStrategy":{
"shape":"SMBSecurityStrategy",
- "documentation":"ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption enabled. This option is recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool.context to your policies, and ID tokens provide principal Attributes.
Namespace::[Entity type]::[User pool ID]|[user principal attribute], for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.Namespace::[Entity type]::[principalIdClaim]|[user principal attribute], for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.Allow or Deny, along with a list of the policies that resulted in the decision.Allow or Deny, along with a list of the policies that resulted in the decision.\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}} \"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}} \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}} \"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}} userPoolArn, a groupConfiguration, and a ClientId.\"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}} \"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}} \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}} \"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}} UserPoolArn, and optionally, a ClientId.{ \"identifier\": { \"entityType\": \"Photo\", \"entityId\": \"VacationPhoto94.jpg\" }, \"attributes\": {}, \"parents\": [ { \"entityType\": \"Album\", \"entityId\": \"alice_folder\" } ] } sub.aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.aud claim, or audiences, that you want to accept.sub.aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.aud claim, or audiences, that you want to accept.sub.aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.aud claim, or audiences, that you want to accept..well-known/openid-configuration.entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.groups claim to MyCorp::UserGroup..well-known/openid-configuration.entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.groups claim to MyCorp::UserGroup..well-known/openid-configuration.entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.groups claim to MyCorp::UserGroup.groups.MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.groups claim to MyCorp::UserGroup.groups.MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.groups claim to MyCorp::UserGroup.groups.MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.groups claim to MyCorp::UserGroup.sub.1example23456789, 2example10111213.aud claim, or audiences, that you want to accept.sub.1example23456789, 2example10111213.aud claim, or audiences, that you want to accept.sub.1example23456789, 2example10111213.aud claim, or audiences, that you want to accept.https://auth.example.com, and the claim that you want to map to the principal, for example sub.1example23456789, and the claim that you want to map to the principal, for example sub.https://auth.example.com, and the claim that you want to map to the principal, for example sub.1example23456789, and the claim that you want to map to the principal, for example sub.https://auth.example.com, and the claim that you want to map to the principal, for example sub.1example23456789, and the claim that you want to map to the principal, for example sub.userPoolArn, and optionally, a ClientId.sub.aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.aud claim, or audiences, that you want to accept..well-known/openid-configuration.entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.groups claim to MyCorp::UserGroup.groups.MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.groups claim to MyCorp::UserGroup.sub.1example23456789, 2example10111213.aud claim, or audiences, that you want to accept.https://auth.example.com, and the claim that you want to map to the principal, for example sub.1example23456789, and the claim that you want to map to the principal, for example sub.