Operations for Amazon Web Services Account Management
", "operations": { + "AcceptPrimaryEmailUpdate": "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.
", "DeleteAlternateContact": "Deletes the specified alternate contact from an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
Disables (opts-out) a particular Region for an account.
", + "DisableRegion": "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.
Enables (opts-in) a particular Region for an account.
", "GetAlternateContact": "Retrieves the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
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.
", + "GetPrimaryEmail": "Retrieves the primary email address for the specified account.
", "GetRegionOptStatus": "Retrieves the opt-in status of a particular Region.
", "ListRegions": "Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.
Modifies the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
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.
" + "PutContactInformation": "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.
", + "StartPrimaryEmailUpdate": "Starts the process to update the primary email address for the specified account.
" }, "shapes": { + "AcceptPrimaryEmailUpdateRequest": { + "base": null, + "refs": { + } + }, + "AcceptPrimaryEmailUpdateResponse": { + "base": null, + "refs": { + } + }, "AccessDeniedException": { "base": "The operation failed because the calling identity doesn't have the minimum required permissions.
", "refs": { @@ -21,15 +34,18 @@ "AccountId": { "base": null, "refs": { + "AcceptPrimaryEmailUpdateRequest$AccountId": "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 AccountId.
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 do not 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, and 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 AccountId; it must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
", - "DisableRegionRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", - "EnableRegionRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", + "DisableRegionRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", + "EnableRegionRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", "GetAlternateContactRequest$AccountId": "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 do not 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, and 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 AccountId; it must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
", - "GetContactInformationRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", - "GetRegionOptStatusRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", - "ListRegionsRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", + "GetContactInformationRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", + "GetPrimaryEmailRequest$AccountId": "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 AccountId.
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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", + "ListRegionsRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", "PutAlternateContactRequest$AccountId": "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 do not 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, and 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 AccountId; it must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
", - "PutContactInformationRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
" + "PutContactInformationRequest$AccountId": "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 AccountId. It must call the operation in standalone context by not including the AccountId parameter.
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.
", + "StartPrimaryEmailUpdateRequest$AccountId": "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 AccountId.
Specifies a name for the alternate contact.
" } }, + "Otp": { + "base": null, + "refs": { + "AcceptPrimaryEmailUpdateRequest$Otp": "The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate API call.
The postal code of the primary contact address.
" } }, + "PrimaryEmailAddress": { + "base": null, + "refs": { + "AcceptPrimaryEmailUpdateRequest$PrimaryEmail": "The new primary email address for use with the specified account. This must match the PrimaryEmail from the StartPrimaryEmailUpdate API call.
Retrieves the primary email address associated with the specified account.
", + "StartPrimaryEmailUpdateRequest$PrimaryEmail": "The new primary email address (also known as the root user email address) to use in the specified account.
" + } + }, + "PrimaryEmailUpdateStatus": { + "base": null, + "refs": { + "AcceptPrimaryEmailUpdateResponse$Status": "Retrieves the status of the accepted primary email update request.
", + "StartPrimaryEmailUpdateResponse$Status": "The status of the primary email update request.
" + } + }, "PutAlternateContactRequest": { "base": null, "refs": { @@ -260,10 +307,20 @@ "ValidationExceptionField$message": "A message about the validation exception.
" } }, + "StartPrimaryEmailUpdateRequest": { + "base": null, + "refs": { + } + }, + "StartPrimaryEmailUpdateResponse": { + "base": null, + "refs": { + } + }, "StateOrRegion": { "base": null, "refs": { - "ContactInformation$StateOrRegion": "The state or region of the primary contact address. This field is required in selected countries.
" + "ContactInformation$StateOrRegion": "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, 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.
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.
", + "service": "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.
", "operations": { "CreateDeliveryStream": "Creates a Firehose delivery stream.
By default, you can create up to 50 delivery streams per Amazon Web Services Region.
This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.
If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
A Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled.
A delivery stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
An Amazon Redshift destination requires an S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.
", "DeleteDeliveryStream": "Deletes a delivery stream and its data.
You can delete a delivery stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a delivery stream that is in the CREATING state. To check the state of a delivery stream, use DescribeDeliveryStream.
DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the delivery stream is marked for deletion, and it goes into the DELETING state.While the delivery stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a delivery stream.
Removal of a delivery stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.
Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.
", "PutRecord": "Writes a single data record into an Amazon Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.
By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Firehose Limits.
Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.
If the PutRecord operation throws a ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.
Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
For information about service quota, see Amazon Firehose Quota.
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
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 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.
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 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.
For the KMS grant creation to be successful, Firehose APIs StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.
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 ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is 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.
You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source.
The 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.
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 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.
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 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.
For the KMS grant creation to be successful, the Firehose API operations StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.
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 ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is 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.
You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source.
The 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.
Disables 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 DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption state of a delivery stream, use DescribeDeliveryStream.
If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination.
The 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.
Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Each delivery stream can have up to 50 tags.
This operation has a limit of five transactions per second per account.
", "UntagDeliveryStream": "Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.
If you specify a tag that doesn't exist, the operation ignores it.
This operation has a limit of five transactions per second per account.
", @@ -229,6 +229,7 @@ "ProcessingConfiguration$Enabled": "Enables or disables data processing.
", "PutRecordBatchOutput$Encrypted": "Indicates whether server-side encryption (SSE) was enabled during this operation.
", "PutRecordOutput$Encrypted": "Indicates whether server-side encryption (SSE) was enabled during this operation.
", + "SecretsManagerConfiguration$Enabled": "Specifies whether you want to use the the secrets manager feature. When set as 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.
Enable Snowflake role
" } }, @@ -859,7 +860,7 @@ "HttpEndpointRequestConfiguration": { "base": "The configuration of the HTTP endpoint request.
", "refs": { - "HttpEndpointDestinationConfiguration$RequestConfiguration": "The configuration of the requeste sent to the HTTP endpoint specified as the destination.
", + "HttpEndpointDestinationConfiguration$RequestConfiguration": "The configuration of the request sent to the HTTP endpoint that is specified as the destination.
", "HttpEndpointDestinationDescription$RequestConfiguration": "The configuration of request sent to the HTTP endpoint specified as the destination.
", "HttpEndpointDestinationUpdate$RequestConfiguration": "The configuration of the request sent to the HTTP endpoint specified as the destination.
" } @@ -1130,7 +1131,7 @@ } }, "ParquetSerDe": { - "base": "A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
", + "base": "A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
", "refs": { "Serializer$ParquetSerDe": "A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
" } @@ -1379,6 +1380,7 @@ "S3DestinationConfiguration$RoleARN": "The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
", "S3DestinationDescription$RoleARN": "The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
", "S3DestinationUpdate$RoleARN": "The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
", + "SecretsManagerConfiguration$RoleARN": "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.
", "SnowflakeDestinationConfiguration$RoleARN": "The Amazon Resource Name (ARN) of the Snowflake role
", "SnowflakeDestinationDescription$RoleARN": "The Amazon Resource Name (ARN) of the Snowflake role
", "SnowflakeDestinationUpdate$RoleARN": "The Amazon Resource Name (ARN) of the Snowflake role
", @@ -1445,6 +1447,29 @@ "DataFormatConversionConfiguration$SchemaConfiguration": "Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
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 True.
The structure that defines how Firehose accesses the secret.
", + "refs": { + "HttpEndpointDestinationConfiguration$SecretsManagerConfiguration": "The configuration that defines how you access secrets for HTTP Endpoint destination.
", + "HttpEndpointDestinationDescription$SecretsManagerConfiguration": "The configuration that defines how you access secrets for HTTP Endpoint destination.
", + "HttpEndpointDestinationUpdate$SecretsManagerConfiguration": "The configuration that defines how you access secrets for HTTP Endpoint destination.
", + "RedshiftDestinationConfiguration$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Amazon Redshift.
", + "RedshiftDestinationDescription$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Amazon Redshift.
", + "RedshiftDestinationUpdate$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Amazon Redshift.
", + "SnowflakeDestinationConfiguration$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Snowflake.
", + "SnowflakeDestinationDescription$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Snowflake.
", + "SnowflakeDestinationUpdate$SecretsManagerConfiguration": "Describes the Secrets Manager configuration in Snowflake.
", + "SplunkDestinationConfiguration$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Splunk.
", + "SplunkDestinationDescription$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Splunk.
", + "SplunkDestinationUpdate$SecretsManagerConfiguration": "The configuration that defines how you access secrets for Splunk.
" + } + }, "SecurityGroupIdList": { "base": null, "refs": { @@ -1516,7 +1541,7 @@ "SnowflakeDestinationUpdate": { "base": "Update to configuration settings
", "refs": { - "UpdateDestinationInput$SnowflakeDestinationUpdate": "Update to the Snowflake destination condiguration settings
" + "UpdateDestinationInput$SnowflakeDestinationUpdate": "Update to the Snowflake destination configuration settings.
" } }, "SnowflakeKeyPassphrase": { diff --git a/models/apis/fsx/2018-03-01/api-2.json b/models/apis/fsx/2018-03-01/api-2.json index af4f10c425e..558fa1a7668 100644 --- a/models/apis/fsx/2018-03-01/api-2.json +++ b/models/apis/fsx/2018-03-01/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"fsx", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceFullName":"Amazon FSx", "serviceId":"FSx", "signatureVersion":"v4", @@ -1355,7 +1356,16 @@ "DriveCacheType":{"shape":"DriveCacheType"}, "DataCompressionType":{"shape":"DataCompressionType"}, "LogConfiguration":{"shape":"LustreLogCreateConfiguration"}, - "RootSquashConfiguration":{"shape":"LustreRootSquashConfiguration"} + "RootSquashConfiguration":{"shape":"LustreRootSquashConfiguration"}, + "MetadataConfiguration":{"shape":"CreateFileSystemLustreMetadataConfiguration"} + } + }, + "CreateFileSystemLustreMetadataConfiguration":{ + "type":"structure", + "required":["Mode"], + "members":{ + "Iops":{"shape":"MetadataIops"}, + "Mode":{"shape":"MetadataConfigurationMode"} } }, "CreateFileSystemOntapConfiguration":{ @@ -2512,6 +2522,14 @@ "MISCONFIGURED_UNAVAILABLE" ] }, + "FileSystemLustreMetadataConfiguration":{ + "type":"structure", + "required":["Mode"], + "members":{ + "Iops":{"shape":"MetadataIops"}, + "Mode":{"shape":"MetadataConfigurationMode"} + } + }, "FileSystemMaintenanceOperation":{ "type":"string", "enum":[ @@ -2801,7 +2819,8 @@ "DriveCacheType":{"shape":"DriveCacheType"}, "DataCompressionType":{"shape":"DataCompressionType"}, "LogConfiguration":{"shape":"LustreLogConfiguration"}, - "RootSquashConfiguration":{"shape":"LustreRootSquashConfiguration"} + "RootSquashConfiguration":{"shape":"LustreRootSquashConfiguration"}, + "MetadataConfiguration":{"shape":"FileSystemLustreMetadataConfiguration"} } }, "LustreFileSystemMountName":{ @@ -2865,6 +2884,18 @@ "max":100000, "min":8 }, + "MetadataConfigurationMode":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "USER_PROVISIONED" + ] + }, + "MetadataIops":{ + "type":"integer", + "max":192000, + "min":1500 + }, "MetadataStorageCapacity":{ "type":"integer", "max":2147483647, @@ -3918,7 +3949,15 @@ "DataCompressionType":{"shape":"DataCompressionType"}, "LogConfiguration":{"shape":"LustreLogCreateConfiguration"}, "RootSquashConfiguration":{"shape":"LustreRootSquashConfiguration"}, - "PerUnitStorageThroughput":{"shape":"PerUnitStorageThroughput"} + "PerUnitStorageThroughput":{"shape":"PerUnitStorageThroughput"}, + "MetadataConfiguration":{"shape":"UpdateFileSystemLustreMetadataConfiguration"} + } + }, + "UpdateFileSystemLustreMetadataConfiguration":{ + "type":"structure", + "members":{ + "Iops":{"shape":"MetadataIops"}, + "Mode":{"shape":"MetadataConfigurationMode"} } }, "UpdateFileSystemOntapConfiguration":{ diff --git a/models/apis/fsx/2018-03-01/docs-2.json b/models/apis/fsx/2018-03-01/docs-2.json index 59ce93b717b..1c12c0b2363 100644 --- a/models/apis/fsx/2018-03-01/docs-2.json +++ b/models/apis/fsx/2018-03-01/docs-2.json @@ -10,7 +10,7 @@ "CreateDataRepositoryAssociation": "Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.
Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.
You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system.
To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
", "CreateFileCache": "Creates a new Amazon File Cache resource.
You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:
Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the cache in JSON format.
The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:
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 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.
If a file system with the specified client request token exists and the parameters match, 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:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system in JSON format.
The 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.
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:
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 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.
If a file system with the specified client request token exists and the parameters match, 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:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system in JSON format.
The 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.
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call 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 a success message as long as the parameters are the same.
The CreateFileSystemFromBackup 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.
Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.
The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
", @@ -19,7 +19,7 @@ "DeleteBackup": "Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.
The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.
The data in a deleted cache 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 FileSystemId value to the DeleFileSystem operation.
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 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.
The 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.
If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).
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 FileSystemId value to the DeleteFileSystem operation.
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 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.
The 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.
If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
", "DeleteVolume": "Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
", @@ -42,7 +42,7 @@ "UntagResource": "This action removes a tag from an Amazon FSx resource.
", "UpdateDataRepositoryAssociation": "Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
", - "UpdateFileSystem": "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:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
PerUnitStorageThroughput
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
HAPairs
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
ThroughputCapacityPerHAPair
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
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:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
MetadataConfiguration
PerUnitStorageThroughput
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
HAPairs
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
ThroughputCapacityPerHAPair
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.
We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems.
Updates the name of an Amazon FSx for OpenZFS snapshot.
", "UpdateStorageVirtualMachine": "Updates an FSx for ONTAP storage virtual machine (SVM).
", @@ -81,7 +81,7 @@ "ActiveDirectoryBackupAttributes$DomainName": "The fully qualified domain name of the self-managed Active Directory directory.
", "SelfManagedActiveDirectoryAttributes$DomainName": "The fully qualified domain name of the self-managed AD directory.
", "SelfManagedActiveDirectoryConfiguration$DomainName": "The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
Specifies an updated fully qualified domain name of your self-managed AD configuration.
" + "SelfManagedActiveDirectoryConfigurationUpdates$DomainName": "Specifies an updated fully qualified domain name of your self-managed Active Directory configuration.
" } }, "AdminPassword": { @@ -193,7 +193,7 @@ "DataRepositoryAssociation$DataRepositoryPath": "The path to the data repository that will be linked to the cache or file system.
For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:
If you are not using the 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.
If you are using the 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.
For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
", - "FileCacheDataRepositoryAssociation$DataRepositoryPath": "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 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.
If you are using the 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.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
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 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.
If you are using the 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.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
The Lustre metadata performance configuration for the creation of an Amazon FSx for Lustre file system using a 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.
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.
", + "refs": { + "CreateFileSystemLustreConfiguration$MetadataConfiguration": "The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2 deployment type.
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
", "refs": { @@ -1096,7 +1102,7 @@ "base": null, "refs": { "SelfManagedActiveDirectoryConfiguration$Password": "The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
", - "SelfManagedActiveDirectoryConfigurationUpdates$Password": "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.
" + "SelfManagedActiveDirectoryConfigurationUpdates$Password": "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.
" } }, "DirectoryUserName": { @@ -1104,7 +1110,7 @@ "refs": { "SelfManagedActiveDirectoryAttributes$UserName": "The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
", "SelfManagedActiveDirectoryConfiguration$UserName": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
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 OrganizationalUnitDistinguishedName.
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 OrganizationalUnitDistinguishedName.
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
", "SelfManagedActiveDirectoryConfiguration$DnsIps": "A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
", - "SelfManagedActiveDirectoryConfigurationUpdates$DnsIps": "A list of up to three DNS server or domain controller IP addresses in your self-managed AD domain.
" + "SelfManagedActiveDirectoryConfigurationUpdates$DnsIps": "A list of up to three DNS server or domain controller IP addresses in your self-managed Active Directory domain.
" } }, "DriveCacheType": { @@ -1347,7 +1353,7 @@ "refs": { "SelfManagedActiveDirectoryAttributes$FileSystemAdministratorsGroup": "The name of the domain group whose members have administrative privileges for the FSx file system.
", "SelfManagedActiveDirectoryConfiguration$FileSystemAdministratorsGroup": "(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
", - "SelfManagedActiveDirectoryConfigurationUpdates$FileSystemAdministratorsGroup": "Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges for the Amazon FSx resource.
" + "SelfManagedActiveDirectoryConfigurationUpdates$FileSystemAdministratorsGroup": "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.
" } }, "FileSystemEndpoint": { @@ -1406,6 +1412,12 @@ "FileSystem$Lifecycle": "The lifecycle status of the file system. The following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED - The file system is in a failed but recoverable state.
MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.
UPDATING - The file system is undergoing a customer-initiated update.
The Lustre metadata performance configuration of an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. The configuration enables the file system to support increasing metadata performance.
The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.
An enumeration specifying the currently ongoing maintenance operation.
", "refs": { @@ -1435,7 +1447,7 @@ "refs": { "CreateFileCacheRequest$FileCacheTypeVersion": "Sets the Lustre version for the cache that you're creating, which must be 2.12.
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.
You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:
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. 2.12 or 2.15 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.
If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.
For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 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.
Default value is 2.10, except for the following deployments:
Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.
Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode.
The Lustre version of the cache, which must be 2.12.
The Lustre version of the cache, which must be 2.12.
The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.
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 StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
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 StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies the type of volume you are creating. Valid values are the following:
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.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
" + "CreateOntapVolumeConfiguration$OntapVolumeType": "Specifies the type of volume you are creating. Valid values are the following:
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.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "IntegerNoMax": { @@ -1721,7 +1733,7 @@ "LustreDeploymentType": { "base": null, "refs": { - "CreateFileSystemLustreConfiguration$DeploymentType": "(Optional) Choose 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.
Choose 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.
Choose 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.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access 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.
(Default = SCRATCH_1)
(Optional) Choose 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.
Choose 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.
Choose 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.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access 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.
(Default = SCRATCH_1)
The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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.
The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.
The default is SCRATCH_1.
The throughput of the Amazon FSx file system, measured in megabytes per second.
" } }, + "MetadataConfigurationMode": { + "base": null, + "refs": { + "CreateFileSystemLustreMetadataConfiguration$Mode": "The metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a PERSISTENT_2 deployment type.
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 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 metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a PERSISTENT_2 deployment type.
To increase the Metadata IOPS or to switch from AUTOMATIC mode, specify 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.
To switch from USER_PROVISIONED mode, specify AUTOMATIC as the value for this parameter, but do not input a value for Iops.
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.
(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 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.
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 number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.
(USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision for your file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.
The value you provide must be greater than or equal to the current number of Metadata IOPS provisioned for the file system.
" + } + }, "MetadataStorageCapacity": { "base": null, "refs": { @@ -2064,7 +2092,7 @@ "refs": { "SelfManagedActiveDirectoryAttributes$OrganizationalUnitDistinguishedName": "The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
", "SelfManagedActiveDirectoryConfiguration$OrganizationalUnitDistinguishedName": "(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD.
" + "SelfManagedActiveDirectoryConfigurationUpdates$OrganizationalUnitDistinguishedName": "Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory.
" } }, "Parameter": { @@ -2297,7 +2325,7 @@ "SecurityStyle": { "base": null, "refs": { - "CreateOntapVolumeConfiguration$SecurityStyle": "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:
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.
For more information, see Volume security style in the FSx for ONTAP User Guide.
", + "CreateOntapVolumeConfiguration$SecurityStyle": "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:
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.
For more information, see Volume security style in the FSx for ONTAP User Guide.
", "OntapVolumeConfiguration$SecurityStyle": "The security style for the volume, which can be UNIX, NTFS, or MIXED.
The security style for the volume, which can be UNIX, NTFS, or MIXED.
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.
", + "base": "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.
", "refs": { "UpdateFileSystemWindowsConfiguration$SelfManagedActiveDirectoryConfiguration": "The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.
", "UpdateSvmActiveDirectoryConfiguration$SelfManagedActiveDirectoryConfiguration": null @@ -2485,7 +2513,7 @@ "refs": { "CreateFileCacheRequest$StorageCapacity": "The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
", "CreateFileSystemFromBackupRequest$StorageCapacity": "Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.
If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
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 StorageType and the Lustre DeploymentType, as follows:
For 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.
For 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.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.
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 StorageType as follows:
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 StorageType and the Lustre DeploymentType, as follows:
For 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.
For 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.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.
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 StorageType as follows:
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).
The storage capacity of the cache in gibibytes (GiB).
", "FileCacheCreating$StorageCapacity": "The storage capacity of the cache in gibibytes (GiB).
", "FileSystem$StorageCapacity": "The storage capacity of the file system in gibibytes (GiB).
Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.
Specifies the file system's storage type.
", "refs": { "CreateFileSystemFromBackupRequest$StorageType": "Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
The default value is SSD.
HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to 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.
Default value is 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.
Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to 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.
Default value is 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.
The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
The security style of the root volume of the SVM. Specify one of the following values:
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.
The security style of the root volume of the SVM. Specify one of the following values:
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.
The security style of the root volume of the SVM.
" } }, @@ -2837,6 +2865,12 @@ "UpdateFileSystemRequest$LustreConfiguration": null } }, + "UpdateFileSystemLustreMetadataConfiguration": { + "base": "The Lustre metadata performance configuration update for an Amazon FSx for Lustre file system using a 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.
The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. When this configuration is enabled, the file system supports increasing metadata performance.
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
", "refs": { @@ -3070,7 +3104,7 @@ "VolumeStyle": { "base": null, "refs": { - "CreateOntapVolumeConfiguration$VolumeStyle": "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.
", + "CreateOntapVolumeConfiguration$VolumeStyle": "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.
", "OntapVolumeConfiguration$VolumeStyle": "Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
" } }, diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index 64184535edd..97cb46f5eed 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -12488,7 +12488,8 @@ "ViewExpandedText":{"shape":"ViewTextString"}, "TableType":{"shape":"TableTypeString"}, "Parameters":{"shape":"ParametersMap"}, - "TargetTable":{"shape":"TableIdentifier"} + "TargetTable":{"shape":"TableIdentifier"}, + "ViewDefinition":{"shape":"ViewDefinitionInput"} } }, "TableList":{ @@ -13372,7 +13373,9 @@ "TableInput":{"shape":"TableInput"}, "SkipArchive":{"shape":"BooleanNullable"}, "TransactionId":{"shape":"TransactionIdString"}, - "VersionId":{"shape":"VersionString"} + "VersionId":{"shape":"VersionString"}, + "ViewUpdateAction":{"shape":"ViewUpdateAction"}, + "Force":{"shape":"Boolean"} } }, "UpdateTableResponse":{ @@ -13532,6 +13535,15 @@ "Representations":{"shape":"ViewRepresentationList"} } }, + "ViewDefinitionInput":{ + "type":"structure", + "members":{ + "IsProtected":{"shape":"NullableBoolean"}, + "Definer":{"shape":"ArnString"}, + "Representations":{"shape":"ViewRepresentationInputList"}, + "SubObjects":{"shape":"ViewSubObjectsList"} + } + }, "ViewDialect":{ "type":"string", "enum":[ @@ -13552,9 +13564,26 @@ "DialectVersion":{"shape":"ViewDialectVersionString"}, "ViewOriginalText":{"shape":"ViewTextString"}, "ViewExpandedText":{"shape":"ViewTextString"}, + "ValidationConnection":{"shape":"NameString"}, "IsStale":{"shape":"NullableBoolean"} } }, + "ViewRepresentationInput":{ + "type":"structure", + "members":{ + "Dialect":{"shape":"ViewDialect"}, + "DialectVersion":{"shape":"ViewDialectVersionString"}, + "ViewOriginalText":{"shape":"ViewTextString"}, + "ValidationConnection":{"shape":"NameString"}, + "ViewExpandedText":{"shape":"ViewTextString"} + } + }, + "ViewRepresentationInputList":{ + "type":"list", + "member":{"shape":"ViewRepresentationInput"}, + "max":10, + "min":1 + }, "ViewRepresentationList":{ "type":"list", "member":{"shape":"ViewRepresentation"}, @@ -13571,6 +13600,15 @@ "type":"string", "max":409600 }, + "ViewUpdateAction":{ + "type":"string", + "enum":[ + "ADD", + "REPLACE", + "ADD_OR_REPLACE", + "DROP" + ] + }, "WorkerType":{ "type":"string", "enum":[ diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index 26487b25994..2a98c8bdc8b 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -360,6 +360,7 @@ "GetUnfilteredTableMetadataResponse$ResourceArn": "The resource ARN of the parent resource extracted from the request.
", "TableOptimizerConfiguration$roleArn": "A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
", "ViewDefinition$Definer": "The definer of a view in SQL.
", + "ViewDefinitionInput$Definer": "The definer of a view in SQL.
", "ViewSubObjectsList$member": null } }, @@ -860,7 +861,8 @@ "StorageDescriptor$Compressed": " True if the data in the table is compressed, or False if not.
True if the table data is stored in subdirectories, or False if not.
Indicates whether the table has been registered with Lake Formation.
", - "UnfilteredPartition$IsRegisteredWithLakeFormation": "A Boolean value indicating that the partition location is registered with Lake Formation.
" + "UnfilteredPartition$IsRegisteredWithLakeFormation": "A Boolean value indicating that the partition location is registered with Lake Formation.
", + "UpdateTableRequest$Force": "A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.
" } }, "BooleanColumnStatisticsData": { @@ -6080,6 +6082,8 @@ "UserDefinedFunctionInput$FunctionName": "The name of the function.
", "UserDefinedFunctionInput$ClassName": "The Java class that contains the function code.
", "UserDefinedFunctionInput$OwnerName": "The owner of the function.
", + "ViewRepresentation$ValidationConnection": "The name of the connection to be used to validate the specific representation of the view.
", + "ViewRepresentationInput$ValidationConnection": "The name of the connection to be used to validate the specific representation of the view.
", "Workflow$Name": "The name of the workflow.
", "WorkflowNames$member": null, "WorkflowRun$Name": "Name of the workflow that was run.
", @@ -6338,6 +6342,7 @@ "UpdateCsvClassifierRequest$AllowSingleColumn": "Enables the processing of files that contain only one column.
", "UpdateCsvClassifierRequest$CustomDatatypeConfigured": "Specifies the configuration of custom datatypes.
", "ViewDefinition$IsProtected": "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.
", + "ViewDefinitionInput$IsProtected": "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.
", "ViewRepresentation$IsStale": "Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
" } }, @@ -9329,18 +9334,26 @@ "Table$ViewDefinition": "A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
" } }, + "ViewDefinitionInput": { + "base": "A structure containing details for creating or updating an Glue view.
", + "refs": { + "TableInput$ViewDefinition": "A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
" + } + }, "ViewDialect": { "base": null, "refs": { "SupportedDialect$Dialect": "The dialect of the query engine.
", - "ViewRepresentation$Dialect": "The dialect of the query engine.
" + "ViewRepresentation$Dialect": "The dialect of the query engine.
", + "ViewRepresentationInput$Dialect": "A parameter that specifies the engine type of a specific representation.
" } }, "ViewDialectVersionString": { "base": null, "refs": { "SupportedDialect$DialectVersion": "The version of the dialect of the query engine. For example, 3.0.0.
", - "ViewRepresentation$DialectVersion": "The version of the dialect of the query engine. For example, 3.0.0.
" + "ViewRepresentation$DialectVersion": "The version of the dialect of the query engine. For example, 3.0.0.
", + "ViewRepresentationInput$DialectVersion": "A parameter that specifies the version of the engine of a specific representation.
" } }, "ViewRepresentation": { @@ -9349,6 +9362,18 @@ "ViewRepresentationList$member": null } }, + "ViewRepresentationInput": { + "base": "A structure containing details of a representation to update or create a Lake Formation view.
", + "refs": { + "ViewRepresentationInputList$member": null + } + }, + "ViewRepresentationInputList": { + "base": null, + "refs": { + "ViewDefinitionInput$Representations": "A list of structures that contains the dialect of the view, and the query that defines the view.
" + } + }, "ViewRepresentationList": { "base": null, "refs": { @@ -9358,7 +9383,8 @@ "ViewSubObjectsList": { "base": null, "refs": { - "ViewDefinition$SubObjects": "A list of table Amazon Resource Names (ARNs).
" + "ViewDefinition$SubObjects": "A list of table Amazon Resource Names (ARNs).
", + "ViewDefinitionInput$SubObjects": "A list of base table ARNs that make up the view.
" } }, "ViewTextString": { @@ -9369,7 +9395,15 @@ "TableInput$ViewOriginalText": "Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
", "ViewRepresentation$ViewOriginalText": "The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view (ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the 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 ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
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 ViewOriginalText to ViewExpandedText. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
A string that represents the original SQL query that describes the view.
", + "ViewRepresentationInput$ViewExpandedText": "A string that represents the SQL query that describes the view with expanded resource ARNs
" + } + }, + "ViewUpdateAction": { + "base": null, + "refs": { + "UpdateTableRequest$ViewUpdateAction": "The operation to be performed when updating the view.
" } }, "WorkerType": { diff --git a/models/apis/iotwireless/2020-11-22/api-2.json b/models/apis/iotwireless/2020-11-22/api-2.json index d6121e5ec4a..7af36af69bd 100644 --- a/models/apis/iotwireless/2020-11-22/api-2.json +++ b/models/apis/iotwireless/2020-11-22/api-2.json @@ -4,6 +4,7 @@ "apiVersion":"2020-11-22", "endpointPrefix":"api.iotwireless", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS IoT Wireless", "serviceId":"IoT Wireless", "signatureVersion":"v4", @@ -3365,7 +3366,8 @@ "MissingFrag", "MemoryError", "MICError", - "Successful" + "Successful", + "Device_exist_in_conflict_fuota_task" ] }, "FuotaTask":{ diff --git a/models/apis/location/2020-11-19/api-2.json b/models/apis/location/2020-11-19/api-2.json index 942a5916e12..188b445a235 100644 --- a/models/apis/location/2020-11-19/api-2.json +++ b/models/apis/location/2020-11-19/api-2.json @@ -3,8 +3,8 @@ "metadata":{ "apiVersion":"2020-11-19", "endpointPrefix":"geo", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon Location Service", "serviceId":"Location", "signatureVersion":"v4", @@ -536,6 +536,24 @@ ], "endpoint":{"hostPrefix":"cp.tracking."} }, + "ForecastGeofenceEvents":{ + "name":"ForecastGeofenceEvents", + "http":{ + "method":"POST", + "requestUri":"/geofencing/v0/collections/{CollectionName}/forecast-geofence-events", + "responseCode":200 + }, + "input":{"shape":"ForecastGeofenceEventsRequest"}, + "output":{"shape":"ForecastGeofenceEventsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"geofencing."} + }, "GetDevicePosition":{ "name":"GetDevicePosition", "http":{ @@ -1076,6 +1094,24 @@ ], "endpoint":{"hostPrefix":"cp.tracking."}, "idempotent":true + }, + "VerifyDevicePosition":{ + "name":"VerifyDevicePosition", + "http":{ + "method":"POST", + "requestUri":"/tracking/v0/trackers/{TrackerName}/positions/verify", + "responseCode":200 + }, + "input":{"shape":"VerifyDevicePositionRequest"}, + "output":{"shape":"VerifyDevicePositionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "endpoint":{"hostPrefix":"tracking."} } }, "shapes":{ @@ -1104,7 +1140,7 @@ "type":"string", "max":200, "min":5, - "pattern":"^geo:\\w*\\*?$" + "pattern":"(geo|geo-routes|geo-places|geo-maps):\\w*\\*?" }, "ApiKeyFilter":{ "type":"structure", @@ -1120,8 +1156,8 @@ ], "members":{ "AllowActions":{"shape":"ApiKeyRestrictionsAllowActionsList"}, - "AllowReferers":{"shape":"ApiKeyRestrictionsAllowReferersList"}, - "AllowResources":{"shape":"ApiKeyRestrictionsAllowResourcesList"} + "AllowResources":{"shape":"ApiKeyRestrictionsAllowResourcesList"}, + "AllowReferers":{"shape":"ApiKeyRestrictionsAllowReferersList"} } }, "ApiKeyRestrictionsAllowActionsList":{ @@ -1138,7 +1174,7 @@ }, "ApiKeyRestrictionsAllowResourcesList":{ "type":"list", - "member":{"shape":"GeoArn"}, + "member":{"shape":"GeoArnV2"}, "max":5, "min":1 }, @@ -1146,7 +1182,7 @@ "type":"string", "max":1600, "min":0, - "pattern":"^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$" + "pattern":"arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?" }, "ArnList":{ "type":"list", @@ -1155,16 +1191,16 @@ "AssociateTrackerConsumerRequest":{ "type":"structure", "required":[ - "ConsumerArn", - "TrackerName" + "TrackerName", + "ConsumerArn" ], "members":{ - "ConsumerArn":{"shape":"Arn"}, "TrackerName":{ "shape":"ResourceName", "location":"uri", "locationName":"TrackerName" - } + }, + "ConsumerArn":{"shape":"Arn"} } }, "AssociateTrackerConsumerResponse":{ @@ -1172,6 +1208,12 @@ "members":{ } }, + "Base64EncodedGeobuf":{ + "type":"blob", + "max":600000, + "min":0, + "sensitive":true + }, "BatchDeleteDevicePositionHistoryError":{ "type":"structure", "required":[ @@ -1190,16 +1232,16 @@ "BatchDeleteDevicePositionHistoryRequest":{ "type":"structure", "required":[ - "DeviceIds", - "TrackerName" + "TrackerName", + "DeviceIds" ], "members":{ - "DeviceIds":{"shape":"BatchDeleteDevicePositionHistoryRequestDeviceIdsList"}, "TrackerName":{ "shape":"ResourceName", "location":"uri", "locationName":"TrackerName" - } + }, + "DeviceIds":{"shape":"BatchDeleteDevicePositionHistoryRequestDeviceIdsList"} } }, "BatchDeleteDevicePositionHistoryRequestDeviceIdsList":{ @@ -1218,12 +1260,12 @@ "BatchDeleteGeofenceError":{ "type":"structure", "required":[ - "Error", - "GeofenceId" + "GeofenceId", + "Error" ], "members":{ - "Error":{"shape":"BatchItemError"}, - "GeofenceId":{"shape":"Id"} + "GeofenceId":{"shape":"Id"}, + "Error":{"shape":"BatchItemError"} } }, "BatchDeleteGeofenceErrorList":{ @@ -1262,13 +1304,13 @@ "type":"structure", "required":[ "DeviceId", - "Error", - "SampleTime" + "SampleTime", + "Error" ], "members":{ "DeviceId":{"shape":"Id"}, - "Error":{"shape":"BatchItemError"}, - "SampleTime":{"shape":"Timestamp"} + "SampleTime":{"shape":"Timestamp"}, + "Error":{"shape":"BatchItemError"} } }, "BatchEvaluateGeofencesErrorList":{ @@ -1321,16 +1363,16 @@ "BatchGetDevicePositionRequest":{ "type":"structure", "required":[ - "DeviceIds", - "TrackerName" + "TrackerName", + "DeviceIds" ], "members":{ - "DeviceIds":{"shape":"BatchGetDevicePositionRequestDeviceIdsList"}, "TrackerName":{ "shape":"BatchGetDevicePositionRequestTrackerNameString", "location":"uri", "locationName":"TrackerName" - } + }, + "DeviceIds":{"shape":"BatchGetDevicePositionRequestDeviceIdsList"} } }, "BatchGetDevicePositionRequestDeviceIdsList":{ @@ -1342,17 +1384,17 @@ "BatchGetDevicePositionRequestTrackerNameString":{ "type":"string", "min":1, - "pattern":"^[-._\\w]+$" + "pattern":"[-._\\w]+" }, "BatchGetDevicePositionResponse":{ "type":"structure", "required":[ - "DevicePositions", - "Errors" + "Errors", + "DevicePositions" ], "members":{ - "DevicePositions":{"shape":"DevicePositionList"}, - "Errors":{"shape":"BatchGetDevicePositionErrorList"} + "Errors":{"shape":"BatchGetDevicePositionErrorList"}, + "DevicePositions":{"shape":"DevicePositionList"} } }, "BatchItemError":{ @@ -1376,12 +1418,12 @@ "BatchPutGeofenceError":{ "type":"structure", "required":[ - "Error", - "GeofenceId" + "GeofenceId", + "Error" ], "members":{ - "Error":{"shape":"BatchItemError"}, - "GeofenceId":{"shape":"Id"} + "GeofenceId":{"shape":"Id"}, + "Error":{"shape":"BatchItemError"} } }, "BatchPutGeofenceErrorList":{ @@ -1417,31 +1459,31 @@ ], "members":{ "GeofenceId":{"shape":"Id"}, - "GeofenceProperties":{"shape":"PropertyMap"}, - "Geometry":{"shape":"GeofenceGeometry"} + "Geometry":{"shape":"GeofenceGeometry"}, + "GeofenceProperties":{"shape":"PropertyMap"} } }, "BatchPutGeofenceResponse":{ "type":"structure", "required":[ - "Errors", - "Successes" + "Successes", + "Errors" ], "members":{ - "Errors":{"shape":"BatchPutGeofenceErrorList"}, - "Successes":{"shape":"BatchPutGeofenceSuccessList"} + "Successes":{"shape":"BatchPutGeofenceSuccessList"}, + "Errors":{"shape":"BatchPutGeofenceErrorList"} } }, "BatchPutGeofenceSuccess":{ "type":"structure", "required":[ - "CreateTime", "GeofenceId", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, "GeofenceId":{"shape":"Id"}, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -1453,13 +1495,13 @@ "type":"structure", "required":[ "DeviceId", - "Error", - "SampleTime" + "SampleTime", + "Error" ], "members":{ "DeviceId":{"shape":"Id"}, - "Error":{"shape":"BatchItemError"}, - "SampleTime":{"shape":"Timestamp"} + "SampleTime":{"shape":"Timestamp"}, + "Error":{"shape":"BatchItemError"} } }, "BatchUpdateDevicePositionErrorList":{ @@ -1526,19 +1568,19 @@ "location":"uri", "locationName":"CalculatorName" }, - "CarModeOptions":{"shape":"CalculateRouteCarModeOptions"}, - "DepartNow":{"shape":"Boolean"}, "DeparturePositions":{"shape":"CalculateRouteMatrixRequestDeparturePositionsList"}, - "DepartureTime":{"shape":"Timestamp"}, "DestinationPositions":{"shape":"CalculateRouteMatrixRequestDestinationPositionsList"}, + "TravelMode":{"shape":"TravelMode"}, + "DepartureTime":{"shape":"Timestamp"}, + "DepartNow":{"shape":"Boolean"}, "DistanceUnit":{"shape":"DistanceUnit"}, + "CarModeOptions":{"shape":"CalculateRouteCarModeOptions"}, + "TruckModeOptions":{"shape":"CalculateRouteTruckModeOptions"}, "Key":{ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "TravelMode":{"shape":"TravelMode"}, - "TruckModeOptions":{"shape":"CalculateRouteTruckModeOptions"} + } } }, "CalculateRouteMatrixRequestDeparturePositionsList":{ @@ -1582,15 +1624,15 @@ "type":"structure", "required":[ "DataSource", - "DistanceUnit", + "RouteCount", "ErrorCount", - "RouteCount" + "DistanceUnit" ], "members":{ "DataSource":{"shape":"String"}, - "DistanceUnit":{"shape":"DistanceUnit"}, + "RouteCount":{"shape":"CalculateRouteMatrixSummaryRouteCountInteger"}, "ErrorCount":{"shape":"CalculateRouteMatrixSummaryErrorCountInteger"}, - "RouteCount":{"shape":"CalculateRouteMatrixSummaryRouteCountInteger"} + "DistanceUnit":{"shape":"DistanceUnit"} } }, "CalculateRouteMatrixSummaryErrorCountInteger":{ @@ -1613,28 +1655,28 @@ "DestinationPosition" ], "members":{ - "ArrivalTime":{"shape":"Timestamp"}, "CalculatorName":{ "shape":"ResourceName", "location":"uri", "locationName":"CalculatorName" }, - "CarModeOptions":{"shape":"CalculateRouteCarModeOptions"}, - "DepartNow":{"shape":"Boolean"}, "DeparturePosition":{"shape":"Position"}, - "DepartureTime":{"shape":"Timestamp"}, "DestinationPosition":{"shape":"Position"}, + "WaypointPositions":{"shape":"CalculateRouteRequestWaypointPositionsList"}, + "TravelMode":{"shape":"TravelMode"}, + "DepartureTime":{"shape":"Timestamp"}, + "DepartNow":{"shape":"Boolean"}, "DistanceUnit":{"shape":"DistanceUnit"}, "IncludeLegGeometry":{"shape":"Boolean"}, + "CarModeOptions":{"shape":"CalculateRouteCarModeOptions"}, + "TruckModeOptions":{"shape":"CalculateRouteTruckModeOptions"}, + "ArrivalTime":{"shape":"Timestamp"}, + "OptimizeFor":{"shape":"OptimizationMode"}, "Key":{ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "OptimizeFor":{"shape":"OptimizationMode"}, - "TravelMode":{"shape":"TravelMode"}, - "TruckModeOptions":{"shape":"CalculateRouteTruckModeOptions"}, - "WaypointPositions":{"shape":"CalculateRouteRequestWaypointPositionsList"} + } } }, "CalculateRouteRequestWaypointPositionsList":{ @@ -1657,18 +1699,18 @@ "CalculateRouteSummary":{ "type":"structure", "required":[ + "RouteBBox", "DataSource", "Distance", - "DistanceUnit", "DurationSeconds", - "RouteBBox" + "DistanceUnit" ], "members":{ + "RouteBBox":{"shape":"BoundingBox"}, "DataSource":{"shape":"String"}, "Distance":{"shape":"CalculateRouteSummaryDistanceDouble"}, - "DistanceUnit":{"shape":"DistanceUnit"}, "DurationSeconds":{"shape":"CalculateRouteSummaryDurationSecondsDouble"}, - "RouteBBox":{"shape":"BoundingBox"} + "DistanceUnit":{"shape":"DistanceUnit"} } }, "CalculateRouteSummaryDistanceDouble":{ @@ -1690,6 +1732,19 @@ "Weight":{"shape":"TruckWeight"} } }, + "CellSignals":{ + "type":"structure", + "required":["LteCellDetails"], + "members":{ + "LteCellDetails":{"shape":"CellSignalsLteCellDetailsList"} + } + }, + "CellSignalsLteCellDetailsList":{ + "type":"list", + "member":{"shape":"LteCellDetails"}, + "max":16, + "min":1 + }, "Circle":{ "type":"structure", "required":[ @@ -1717,25 +1772,21 @@ }, "exception":true }, - "CountryCode":{ - "type":"string", - "pattern":"^[A-Z]{3}$" - }, "CountryCode3":{ "type":"string", "max":3, "min":3, - "pattern":"^[A-Z]{3}$" + "pattern":"[A-Z]{3}" }, "CountryCode3OrEmpty":{ "type":"string", "max":3, "min":0, - "pattern":"^[A-Z]{3}$|^$" + "pattern":"[A-Z]{3}$|^" }, "CountryCodeList":{ "type":"list", - "member":{"shape":"CountryCode"}, + "member":{"shape":"CountryCode3"}, "max":100, "min":1 }, @@ -1744,8 +1795,6 @@ "required":["CollectionName"], "members":{ "CollectionName":{"shape":"ResourceName"}, - "Description":{"shape":"ResourceDescription"}, - "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, @@ -1756,19 +1805,21 @@ "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed." }, - "Tags":{"shape":"TagMap"} + "Description":{"shape":"ResourceDescription"}, + "Tags":{"shape":"TagMap"}, + "KmsKeyId":{"shape":"KmsKeyId"} } }, "CreateGeofenceCollectionResponse":{ "type":"structure", "required":[ - "CollectionArn", "CollectionName", + "CollectionArn", "CreateTime" ], "members":{ - "CollectionArn":{"shape":"Arn"}, "CollectionName":{"shape":"ResourceName"}, + "CollectionArn":{"shape":"Arn"}, "CreateTime":{"shape":"Timestamp"} } }, @@ -1779,90 +1830,90 @@ "Restrictions" ], "members":{ + "KeyName":{"shape":"ResourceName"}, + "Restrictions":{"shape":"ApiKeyRestrictions"}, "Description":{"shape":"ResourceDescription"}, "ExpireTime":{"shape":"Timestamp"}, - "KeyName":{"shape":"ResourceName"}, "NoExpiry":{"shape":"Boolean"}, - "Restrictions":{"shape":"ApiKeyRestrictions"}, "Tags":{"shape":"TagMap"} } }, "CreateKeyResponse":{ "type":"structure", "required":[ - "CreateTime", "Key", "KeyArn", - "KeyName" + "KeyName", + "CreateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, "Key":{"shape":"ApiKey"}, "KeyArn":{"shape":"Arn"}, - "KeyName":{"shape":"ResourceName"} + "KeyName":{"shape":"ResourceName"}, + "CreateTime":{"shape":"Timestamp"} } }, "CreateMapRequest":{ "type":"structure", "required":[ - "Configuration", - "MapName" + "MapName", + "Configuration" ], "members":{ - "Configuration":{"shape":"MapConfiguration"}, - "Description":{"shape":"ResourceDescription"}, "MapName":{"shape":"ResourceName"}, + "Configuration":{"shape":"MapConfiguration"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." }, + "Description":{"shape":"ResourceDescription"}, "Tags":{"shape":"TagMap"} } }, "CreateMapResponse":{ "type":"structure", "required":[ - "CreateTime", + "MapName", "MapArn", - "MapName" + "CreateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, + "MapName":{"shape":"ResourceName"}, "MapArn":{"shape":"GeoArn"}, - "MapName":{"shape":"ResourceName"} + "CreateTime":{"shape":"Timestamp"} } }, "CreatePlaceIndexRequest":{ "type":"structure", "required":[ - "DataSource", - "IndexName" + "IndexName", + "DataSource" ], "members":{ - "DataSource":{"shape":"String"}, - "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, - "Description":{"shape":"ResourceDescription"}, "IndexName":{"shape":"ResourceName"}, + "DataSource":{"shape":"String"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." }, + "Description":{"shape":"ResourceDescription"}, + "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, "Tags":{"shape":"TagMap"} } }, "CreatePlaceIndexResponse":{ "type":"structure", "required":[ - "CreateTime", + "IndexName", "IndexArn", - "IndexName" + "CreateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, + "IndexName":{"shape":"ResourceName"}, "IndexArn":{"shape":"GeoArn"}, - "IndexName":{"shape":"ResourceName"} + "CreateTime":{"shape":"Timestamp"} } }, "CreateRouteCalculatorRequest":{ @@ -1874,25 +1925,25 @@ "members":{ "CalculatorName":{"shape":"ResourceName"}, "DataSource":{"shape":"String"}, - "Description":{"shape":"ResourceDescription"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." }, + "Description":{"shape":"ResourceDescription"}, "Tags":{"shape":"TagMap"} } }, "CreateRouteCalculatorResponse":{ "type":"structure", "required":[ - "CalculatorArn", "CalculatorName", + "CalculatorArn", "CreateTime" ], "members":{ - "CalculatorArn":{"shape":"GeoArn"}, "CalculatorName":{"shape":"ResourceName"}, + "CalculatorArn":{"shape":"GeoArn"}, "CreateTime":{"shape":"Timestamp"} } }, @@ -1900,43 +1951,43 @@ "type":"structure", "required":["TrackerName"], "members":{ - "Description":{"shape":"ResourceDescription"}, - "EventBridgeEnabled":{"shape":"Boolean"}, - "KmsKeyEnableGeospatialQueries":{"shape":"Boolean"}, - "KmsKeyId":{"shape":"KmsKeyId"}, - "PositionFiltering":{"shape":"PositionFiltering"}, + "TrackerName":{"shape":"ResourceName"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." }, + "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlanDataSource":{ "shape":"String", "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed." }, + "Description":{"shape":"ResourceDescription"}, "Tags":{"shape":"TagMap"}, - "TrackerName":{"shape":"ResourceName"} + "PositionFiltering":{"shape":"PositionFiltering"}, + "EventBridgeEnabled":{"shape":"Boolean"}, + "KmsKeyEnableGeospatialQueries":{"shape":"Boolean"} } }, "CreateTrackerResponse":{ "type":"structure", "required":[ - "CreateTime", + "TrackerName", "TrackerArn", - "TrackerName" + "CreateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, + "TrackerName":{"shape":"ResourceName"}, "TrackerArn":{"shape":"Arn"}, - "TrackerName":{"shape":"ResourceName"} + "CreateTime":{"shape":"Timestamp"} } }, "CustomLayer":{ "type":"string", "max":100, "min":1, - "pattern":"^[-._\\w]+$" + "pattern":"[-._\\w]+" }, "CustomLayerList":{ "type":"list", @@ -1970,15 +2021,15 @@ "type":"structure", "required":["KeyName"], "members":{ - "ForceDelete":{ - "shape":"Boolean", - "location":"querystring", - "locationName":"forceDelete" - }, "KeyName":{ "shape":"ResourceName", "location":"uri", "locationName":"KeyName" + }, + "ForceDelete":{ + "shape":"Boolean", + "location":"querystring", + "locationName":"forceDelete" } } }, @@ -2065,19 +2116,16 @@ "DescribeGeofenceCollectionResponse":{ "type":"structure", "required":[ - "CollectionArn", "CollectionName", - "CreateTime", + "CollectionArn", "Description", + "CreateTime", "UpdateTime" ], "members":{ - "CollectionArn":{"shape":"Arn"}, "CollectionName":{"shape":"ResourceName"}, - "CreateTime":{"shape":"Timestamp"}, + "CollectionArn":{"shape":"Arn"}, "Description":{"shape":"ResourceDescription"}, - "GeofenceCount":{"shape":"DescribeGeofenceCollectionResponseGeofenceCountInteger"}, - "KmsKeyId":{"shape":"KmsKeyId"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, @@ -2088,8 +2136,11 @@ "deprecated":true, "deprecatedMessage":"Deprecated. Unused." }, + "KmsKeyId":{"shape":"KmsKeyId"}, "Tags":{"shape":"TagMap"}, - "UpdateTime":{"shape":"Timestamp"} + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "GeofenceCount":{"shape":"DescribeGeofenceCollectionResponseGeofenceCountInteger"} } }, "DescribeGeofenceCollectionResponseGeofenceCountInteger":{ @@ -2111,24 +2162,24 @@ "DescribeKeyResponse":{ "type":"structure", "required":[ - "CreateTime", - "ExpireTime", "Key", "KeyArn", "KeyName", "Restrictions", + "CreateTime", + "ExpireTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, - "Description":{"shape":"ResourceDescription"}, - "ExpireTime":{"shape":"Timestamp"}, "Key":{"shape":"ApiKey"}, "KeyArn":{"shape":"Arn"}, "KeyName":{"shape":"ResourceName"}, "Restrictions":{"shape":"ApiKeyRestrictions"}, - "Tags":{"shape":"TagMap"}, - "UpdateTime":{"shape":"Timestamp"} + "CreateTime":{"shape":"Timestamp"}, + "ExpireTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "Description":{"shape":"ResourceDescription"}, + "Tags":{"shape":"TagMap"} } }, "DescribeMapRequest":{ @@ -2145,27 +2196,27 @@ "DescribeMapResponse":{ "type":"structure", "required":[ - "Configuration", - "CreateTime", + "MapName", + "MapArn", "DataSource", + "Configuration", "Description", - "MapArn", - "MapName", + "CreateTime", "UpdateTime" ], "members":{ - "Configuration":{"shape":"MapConfiguration"}, - "CreateTime":{"shape":"Timestamp"}, - "DataSource":{"shape":"String"}, - "Description":{"shape":"ResourceDescription"}, - "MapArn":{"shape":"GeoArn"}, "MapName":{"shape":"ResourceName"}, + "MapArn":{"shape":"GeoArn"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." }, + "DataSource":{"shape":"String"}, + "Configuration":{"shape":"MapConfiguration"}, + "Description":{"shape":"ResourceDescription"}, "Tags":{"shape":"TagMap"}, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -2183,28 +2234,28 @@ "DescribePlaceIndexResponse":{ "type":"structure", "required":[ + "IndexName", + "IndexArn", + "Description", "CreateTime", + "UpdateTime", "DataSource", - "DataSourceConfiguration", - "Description", - "IndexArn", - "IndexName", - "UpdateTime" + "DataSourceConfiguration" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, - "DataSource":{"shape":"String"}, - "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, - "Description":{"shape":"ResourceDescription"}, - "IndexArn":{"shape":"GeoArn"}, "IndexName":{"shape":"ResourceName"}, + "IndexArn":{"shape":"GeoArn"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." }, - "Tags":{"shape":"TagMap"}, - "UpdateTime":{"shape":"Timestamp"} + "Description":{"shape":"ResourceDescription"}, + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "DataSource":{"shape":"String"}, + "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, + "Tags":{"shape":"TagMap"} } }, "DescribeRouteCalculatorRequest":{ @@ -2221,27 +2272,27 @@ "DescribeRouteCalculatorResponse":{ "type":"structure", "required":[ - "CalculatorArn", "CalculatorName", - "CreateTime", - "DataSource", + "CalculatorArn", "Description", - "UpdateTime" + "CreateTime", + "UpdateTime", + "DataSource" ], "members":{ - "CalculatorArn":{"shape":"GeoArn"}, "CalculatorName":{"shape":"ResourceName"}, - "CreateTime":{"shape":"Timestamp"}, - "DataSource":{"shape":"String"}, - "Description":{"shape":"ResourceDescription"}, + "CalculatorArn":{"shape":"GeoArn"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." }, - "Tags":{"shape":"TagMap"}, - "UpdateTime":{"shape":"Timestamp"} - } + "Description":{"shape":"ResourceDescription"}, + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "DataSource":{"shape":"String"}, + "Tags":{"shape":"TagMap"} + } }, "DescribeTrackerRequest":{ "type":"structure", @@ -2257,19 +2308,16 @@ "DescribeTrackerResponse":{ "type":"structure", "required":[ - "CreateTime", - "Description", - "TrackerArn", "TrackerName", + "TrackerArn", + "Description", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, + "TrackerName":{"shape":"ResourceName"}, + "TrackerArn":{"shape":"Arn"}, "Description":{"shape":"ResourceDescription"}, - "EventBridgeEnabled":{"shape":"Boolean"}, - "KmsKeyEnableGeospatialQueries":{"shape":"Boolean"}, - "KmsKeyId":{"shape":"KmsKeyId"}, - "PositionFiltering":{"shape":"PositionFiltering"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, @@ -2281,25 +2329,28 @@ "deprecatedMessage":"Deprecated. Unused." }, "Tags":{"shape":"TagMap"}, - "TrackerArn":{"shape":"Arn"}, - "TrackerName":{"shape":"ResourceName"}, - "UpdateTime":{"shape":"Timestamp"} + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "KmsKeyId":{"shape":"KmsKeyId"}, + "PositionFiltering":{"shape":"PositionFiltering"}, + "EventBridgeEnabled":{"shape":"Boolean"}, + "KmsKeyEnableGeospatialQueries":{"shape":"Boolean"} } }, "DevicePosition":{ "type":"structure", "required":[ - "Position", + "SampleTime", "ReceivedTime", - "SampleTime" + "Position" ], "members":{ - "Accuracy":{"shape":"PositionalAccuracy"}, "DeviceId":{"shape":"Id"}, - "Position":{"shape":"Position"}, - "PositionProperties":{"shape":"PropertyMap"}, + "SampleTime":{"shape":"Timestamp"}, "ReceivedTime":{"shape":"Timestamp"}, - "SampleTime":{"shape":"Timestamp"} + "Position":{"shape":"Position"}, + "Accuracy":{"shape":"PositionalAccuracy"}, + "PositionProperties":{"shape":"PropertyMap"} } }, "DevicePositionList":{ @@ -2310,17 +2361,38 @@ "type":"structure", "required":[ "DeviceId", - "Position", - "SampleTime" + "SampleTime", + "Position" ], "members":{ + "DeviceId":{"shape":"Id"}, + "SampleTime":{"shape":"Timestamp"}, + "Position":{"shape":"Position"}, "Accuracy":{"shape":"PositionalAccuracy"}, + "PositionProperties":{"shape":"PropertyMap"} + } + }, + "DeviceState":{ + "type":"structure", + "required":[ + "DeviceId", + "SampleTime", + "Position" + ], + "members":{ "DeviceId":{"shape":"Id"}, + "SampleTime":{"shape":"Timestamp"}, "Position":{"shape":"Position"}, - "PositionProperties":{"shape":"PropertyMap"}, - "SampleTime":{"shape":"Timestamp"} + "Accuracy":{"shape":"PositionalAccuracy"}, + "Ipv4Address":{"shape":"DeviceStateIpv4AddressString"}, + "WiFiAccessPoints":{"shape":"WiFiAccessPointList"}, + "CellSignals":{"shape":"CellSignals"} } }, + "DeviceStateIpv4AddressString":{ + "type":"string", + "pattern":"(?:(?:25[0-5]|(?:2[0-4]|1\\d|[0-9]|)\\d)\\.?\\b){4}" + }, "DimensionUnit":{ "type":"string", "enum":[ @@ -2331,19 +2403,19 @@ "DisassociateTrackerConsumerRequest":{ "type":"structure", "required":[ - "ConsumerArn", - "TrackerName" + "TrackerName", + "ConsumerArn" ], "members":{ - "ConsumerArn":{ - "shape":"Arn", - "location":"uri", - "locationName":"ConsumerArn" - }, "TrackerName":{ "shape":"ResourceName", "location":"uri", "locationName":"TrackerName" + }, + "ConsumerArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ConsumerArn" } } }, @@ -2363,46 +2435,152 @@ "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"}, + "Speed":{"shape":"ForecastGeofenceEventsDeviceStateSpeedDouble"} + } + }, + "ForecastGeofenceEventsDeviceStateSpeedDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "ForecastGeofenceEventsRequest":{ + "type":"structure", + "required":[ + "CollectionName", + "DeviceState" + ], + "members":{ + "CollectionName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"CollectionName" + }, + "DeviceState":{"shape":"ForecastGeofenceEventsDeviceState"}, + "TimeHorizonMinutes":{"shape":"ForecastGeofenceEventsRequestTimeHorizonMinutesDouble"}, + "DistanceUnit":{"shape":"DistanceUnit"}, + "SpeedUnit":{"shape":"SpeedUnit"}, + "NextToken":{"shape":"LargeToken"}, + "MaxResults":{"shape":"ForecastGeofenceEventsRequestMaxResultsInteger"} + } + }, + "ForecastGeofenceEventsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "ForecastGeofenceEventsRequestTimeHorizonMinutesDouble":{ + "type":"double", + "box":true, + "min":0 + }, + "ForecastGeofenceEventsResponse":{ + "type":"structure", + "required":[ + "ForecastedEvents", + "DistanceUnit", + "SpeedUnit" + ], + "members":{ + "ForecastedEvents":{"shape":"ForecastedEventsList"}, + "NextToken":{"shape":"LargeToken"}, + "DistanceUnit":{"shape":"DistanceUnit"}, + "SpeedUnit":{"shape":"SpeedUnit"} + } + }, + "ForecastedEvent":{ + "type":"structure", + "required":[ + "EventId", + "GeofenceId", + "IsDeviceInGeofence", + "NearestDistance", + "EventType" + ], + "members":{ + "EventId":{"shape":"Uuid"}, + "GeofenceId":{"shape":"Id"}, + "IsDeviceInGeofence":{"shape":"Boolean"}, + "NearestDistance":{"shape":"NearestDistance"}, + "EventType":{"shape":"ForecastedGeofenceEventType"}, + "ForecastedBreachTime":{"shape":"Timestamp"}, + "GeofenceProperties":{"shape":"PropertyMap"} + } + }, + "ForecastedEventsList":{ + "type":"list", + "member":{"shape":"ForecastedEvent"} + }, + "ForecastedGeofenceEventType":{ + "type":"string", + "enum":[ + "ENTER", + "EXIT", + "IDLE" + ] + }, "GeoArn":{ "type":"string", "max":1600, "min":0, - "pattern":"^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$" + "pattern":"arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))" + }, + "GeoArnV2":{ + "type":"string", + "max":1600, + "min":0, + "pattern":".*(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$).*" }, "GeofenceGeometry":{ "type":"structure", "members":{ + "Polygon":{"shape":"LinearRings"}, "Circle":{"shape":"Circle"}, - "Polygon":{"shape":"LinearRings"} + "Geobuf":{"shape":"Base64EncodedGeobuf"} } }, "GetDevicePositionHistoryRequest":{ "type":"structure", "required":[ - "DeviceId", - "TrackerName" + "TrackerName", + "DeviceId" ], "members":{ + "TrackerName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"TrackerName" + }, "DeviceId":{ "shape":"Id", "location":"uri", "locationName":"DeviceId" }, - "EndTimeExclusive":{"shape":"Timestamp"}, - "MaxResults":{"shape":"GetDevicePositionHistoryRequestMaxResultsInteger"}, "NextToken":{"shape":"Token"}, "StartTimeInclusive":{"shape":"Timestamp"}, - "TrackerName":{ - "shape":"ResourceName", - "location":"uri", - "locationName":"TrackerName" - } + "EndTimeExclusive":{"shape":"Timestamp"}, + "MaxResults":{"shape":"GetDevicePositionHistoryRequestMaxResultsInteger"} } }, "GetDevicePositionHistoryRequestMaxResultsInteger":{ @@ -2422,36 +2600,36 @@ "GetDevicePositionRequest":{ "type":"structure", "required":[ - "DeviceId", - "TrackerName" + "TrackerName", + "DeviceId" ], "members":{ - "DeviceId":{ - "shape":"Id", - "location":"uri", - "locationName":"DeviceId" - }, "TrackerName":{ "shape":"ResourceName", "location":"uri", "locationName":"TrackerName" + }, + "DeviceId":{ + "shape":"Id", + "location":"uri", + "locationName":"DeviceId" } } }, "GetDevicePositionResponse":{ "type":"structure", "required":[ - "Position", + "SampleTime", "ReceivedTime", - "SampleTime" + "Position" ], "members":{ - "Accuracy":{"shape":"PositionalAccuracy"}, "DeviceId":{"shape":"Id"}, - "Position":{"shape":"Position"}, - "PositionProperties":{"shape":"PropertyMap"}, + "SampleTime":{"shape":"Timestamp"}, "ReceivedTime":{"shape":"Timestamp"}, - "SampleTime":{"shape":"Timestamp"} + "Position":{"shape":"Position"}, + "Accuracy":{"shape":"PositionalAccuracy"}, + "PositionProperties":{"shape":"PropertyMap"} } }, "GetGeofenceRequest":{ @@ -2476,29 +2654,34 @@ "GetGeofenceResponse":{ "type":"structure", "required":[ - "CreateTime", "GeofenceId", "Geometry", "Status", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, "GeofenceId":{"shape":"Id"}, - "GeofenceProperties":{"shape":"PropertyMap"}, "Geometry":{"shape":"GeofenceGeometry"}, "Status":{"shape":"String"}, - "UpdateTime":{"shape":"Timestamp"} + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "GeofenceProperties":{"shape":"PropertyMap"} } }, "GetMapGlyphsRequest":{ "type":"structure", "required":[ + "MapName", "FontStack", - "FontUnicodeRange", - "MapName" + "FontUnicodeRange" ], "members":{ + "MapName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"MapName" + }, "FontStack":{ "shape":"String", "location":"uri", @@ -2513,31 +2696,26 @@ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "MapName":{ - "shape":"ResourceName", - "location":"uri", - "locationName":"MapName" } } }, "GetMapGlyphsRequestFontUnicodeRangeString":{ "type":"string", - "pattern":"^[0-9]+-[0-9]+\\.pbf$" + "pattern":"[0-9]+-[0-9]+\\.pbf" }, "GetMapGlyphsResponse":{ "type":"structure", "members":{ "Blob":{"shape":"Blob"}, - "CacheControl":{ + "ContentType":{ "shape":"String", "location":"header", - "locationName":"Cache-Control" + "locationName":"Content-Type" }, - "ContentType":{ + "CacheControl":{ "shape":"String", "location":"header", - "locationName":"Content-Type" + "locationName":"Cache-Control" } }, "payload":"Blob" @@ -2545,10 +2723,15 @@ "GetMapSpritesRequest":{ "type":"structure", "required":[ - "FileName", - "MapName" + "MapName", + "FileName" ], "members":{ + "MapName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"MapName" + }, "FileName":{ "shape":"GetMapSpritesRequestFileNameString", "location":"uri", @@ -2558,31 +2741,26 @@ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "MapName":{ - "shape":"ResourceName", - "location":"uri", - "locationName":"MapName" } } }, "GetMapSpritesRequestFileNameString":{ "type":"string", - "pattern":"^sprites(@2x)?\\.(png|json)$" + "pattern":"sprites(@2x)?\\.(png|json)" }, "GetMapSpritesResponse":{ "type":"structure", "members":{ "Blob":{"shape":"Blob"}, - "CacheControl":{ + "ContentType":{ "shape":"String", "location":"header", - "locationName":"Cache-Control" + "locationName":"Content-Type" }, - "ContentType":{ + "CacheControl":{ "shape":"String", "location":"header", - "locationName":"Content-Type" + "locationName":"Cache-Control" } }, "payload":"Blob" @@ -2591,15 +2769,15 @@ "type":"structure", "required":["MapName"], "members":{ - "Key":{ - "shape":"ApiKey", - "location":"querystring", - "locationName":"key" - }, "MapName":{ "shape":"ResourceName", "location":"uri", "locationName":"MapName" + }, + "Key":{ + "shape":"ApiKey", + "location":"querystring", + "locationName":"key" } } }, @@ -2607,15 +2785,15 @@ "type":"structure", "members":{ "Blob":{"shape":"Blob"}, - "CacheControl":{ + "ContentType":{ "shape":"String", "location":"header", - "locationName":"Cache-Control" + "locationName":"Content-Type" }, - "ContentType":{ + "CacheControl":{ "shape":"String", "location":"header", - "locationName":"Content-Type" + "locationName":"Cache-Control" } }, "payload":"Blob" @@ -2624,21 +2802,21 @@ "type":"structure", "required":[ "MapName", + "Z", "X", - "Y", - "Z" + "Y" ], "members":{ - "Key":{ - "shape":"ApiKey", - "location":"querystring", - "locationName":"key" - }, "MapName":{ "shape":"ResourceName", "location":"uri", "locationName":"MapName" }, + "Z":{ + "shape":"GetMapTileRequestZString", + "location":"uri", + "locationName":"Z" + }, "X":{ "shape":"GetMapTileRequestXString", "location":"uri", @@ -2649,38 +2827,38 @@ "location":"uri", "locationName":"Y" }, - "Z":{ - "shape":"GetMapTileRequestZString", - "location":"uri", - "locationName":"Z" + "Key":{ + "shape":"ApiKey", + "location":"querystring", + "locationName":"key" } } }, "GetMapTileRequestXString":{ "type":"string", - "pattern":"\\d+" + "pattern":".*\\d+.*" }, "GetMapTileRequestYString":{ "type":"string", - "pattern":"\\d+" + "pattern":".*\\d+.*" }, "GetMapTileRequestZString":{ "type":"string", - "pattern":"\\d+" + "pattern":".*\\d+.*" }, "GetMapTileResponse":{ "type":"structure", "members":{ "Blob":{"shape":"Blob"}, - "CacheControl":{ + "ContentType":{ "shape":"String", "location":"header", - "locationName":"Cache-Control" + "locationName":"Content-Type" }, - "ContentType":{ + "CacheControl":{ "shape":"String", "location":"header", - "locationName":"Content-Type" + "locationName":"Cache-Control" } }, "payload":"Blob" @@ -2697,20 +2875,20 @@ "location":"uri", "locationName":"IndexName" }, - "Key":{ - "shape":"ApiKey", - "location":"querystring", - "locationName":"key" + "PlaceId":{ + "shape":"PlaceId", + "location":"uri", + "locationName":"PlaceId" }, "Language":{ "shape":"LanguageTag", "location":"querystring", "locationName":"language" }, - "PlaceId":{ - "shape":"PlaceId", - "location":"uri", - "locationName":"PlaceId" + "Key":{ + "shape":"ApiKey", + "location":"querystring", + "locationName":"key" } } }, @@ -2725,7 +2903,17 @@ "type":"string", "max":100, "min":1, - "pattern":"^[-._\\p{L}\\p{N}]+$" + "pattern":"[-._\\p{L}\\p{N}]+" + }, + "InferredState":{ + "type":"structure", + "required":["ProxyDetected"], + "members":{ + "Position":{"shape":"Position"}, + "Accuracy":{"shape":"PositionalAccuracy"}, + "DeviationDistance":{"shape":"Double"}, + "ProxyDetected":{"shape":"Boolean"} + } }, "Integer":{ "type":"integer", @@ -2762,21 +2950,26 @@ "max":35, "min":2 }, + "LargeToken":{ + "type":"string", + "max":60000, + "min":1 + }, "Leg":{ "type":"structure", "required":[ + "StartPosition", + "EndPosition", "Distance", "DurationSeconds", - "EndPosition", - "StartPosition", "Steps" ], "members":{ + "StartPosition":{"shape":"Position"}, + "EndPosition":{"shape":"Position"}, "Distance":{"shape":"LegDistanceDouble"}, "DurationSeconds":{"shape":"LegDurationSecondsDouble"}, - "EndPosition":{"shape":"Position"}, "Geometry":{"shape":"LegGeometry"}, - "StartPosition":{"shape":"Position"}, "Steps":{"shape":"StepList"} } }, @@ -2819,14 +3012,14 @@ "type":"structure", "required":["TrackerName"], "members":{ - "FilterGeometry":{"shape":"TrackingFilterGeometry"}, - "MaxResults":{"shape":"ListDevicePositionsRequestMaxResultsInteger"}, - "NextToken":{"shape":"Token"}, "TrackerName":{ "shape":"ResourceName", "location":"uri", "locationName":"TrackerName" - } + }, + "MaxResults":{"shape":"ListDevicePositionsRequestMaxResultsInteger"}, + "NextToken":{"shape":"Token"}, + "FilterGeometry":{"shape":"TrackingFilterGeometry"} } }, "ListDevicePositionsRequestMaxResultsInteger":{ @@ -2847,15 +3040,15 @@ "type":"structure", "required":[ "DeviceId", - "Position", - "SampleTime" + "SampleTime", + "Position" ], "members":{ - "Accuracy":{"shape":"PositionalAccuracy"}, "DeviceId":{"shape":"Id"}, + "SampleTime":{"shape":"Timestamp"}, "Position":{"shape":"Position"}, - "PositionProperties":{"shape":"PropertyMap"}, - "SampleTime":{"shape":"Timestamp"} + "Accuracy":{"shape":"PositionalAccuracy"}, + "PositionProperties":{"shape":"PropertyMap"} } }, "ListDevicePositionsResponseEntryList":{ @@ -2887,13 +3080,12 @@ "type":"structure", "required":[ "CollectionName", - "CreateTime", "Description", + "CreateTime", "UpdateTime" ], "members":{ "CollectionName":{"shape":"ResourceName"}, - "CreateTime":{"shape":"Timestamp"}, "Description":{"shape":"ResourceDescription"}, "PricingPlan":{ "shape":"PricingPlan", @@ -2905,6 +3097,7 @@ "deprecated":true, "deprecatedMessage":"Deprecated. Unused." }, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -2915,19 +3108,19 @@ "ListGeofenceResponseEntry":{ "type":"structure", "required":[ - "CreateTime", "GeofenceId", "Geometry", "Status", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, "GeofenceId":{"shape":"Id"}, - "GeofenceProperties":{"shape":"PropertyMap"}, "Geometry":{"shape":"GeofenceGeometry"}, "Status":{"shape":"String"}, - "UpdateTime":{"shape":"Timestamp"} + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"}, + "GeofenceProperties":{"shape":"PropertyMap"} } }, "ListGeofenceResponseEntryList":{ @@ -2943,8 +3136,8 @@ "location":"uri", "locationName":"CollectionName" }, - "MaxResults":{"shape":"ListGeofencesRequestMaxResultsInteger"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"LargeToken"}, + "MaxResults":{"shape":"ListGeofencesRequestMaxResultsInteger"} } }, "ListGeofencesRequestMaxResultsInteger":{ @@ -2958,15 +3151,15 @@ "required":["Entries"], "members":{ "Entries":{"shape":"ListGeofenceResponseEntryList"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"LargeToken"} } }, "ListKeysRequest":{ "type":"structure", "members":{ - "Filter":{"shape":"ApiKeyFilter"}, "MaxResults":{"shape":"ListKeysRequestMaxResultsInteger"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"Token"}, + "Filter":{"shape":"ApiKeyFilter"} } }, "ListKeysRequestMaxResultsInteger":{ @@ -2986,18 +3179,18 @@ "ListKeysResponseEntry":{ "type":"structure", "required":[ - "CreateTime", - "ExpireTime", "KeyName", + "ExpireTime", "Restrictions", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, - "Description":{"shape":"ResourceDescription"}, - "ExpireTime":{"shape":"Timestamp"}, "KeyName":{"shape":"ResourceName"}, + "ExpireTime":{"shape":"Timestamp"}, + "Description":{"shape":"ResourceDescription"}, "Restrictions":{"shape":"ApiKeyRestrictions"}, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -3029,22 +3222,22 @@ "ListMapsResponseEntry":{ "type":"structure", "required":[ - "CreateTime", - "DataSource", - "Description", "MapName", + "Description", + "DataSource", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, - "DataSource":{"shape":"String"}, - "Description":{"shape":"ResourceDescription"}, "MapName":{"shape":"ResourceName"}, + "Description":{"shape":"ResourceDescription"}, + "DataSource":{"shape":"String"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." }, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -3076,22 +3269,22 @@ "ListPlaceIndexesResponseEntry":{ "type":"structure", "required":[ - "CreateTime", - "DataSource", - "Description", "IndexName", + "Description", + "DataSource", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, - "DataSource":{"shape":"String"}, - "Description":{"shape":"ResourceDescription"}, "IndexName":{"shape":"ResourceName"}, + "Description":{"shape":"ResourceDescription"}, + "DataSource":{"shape":"String"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." }, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -3124,21 +3317,21 @@ "type":"structure", "required":[ "CalculatorName", - "CreateTime", - "DataSource", "Description", + "DataSource", + "CreateTime", "UpdateTime" ], "members":{ "CalculatorName":{"shape":"ResourceName"}, - "CreateTime":{"shape":"Timestamp"}, - "DataSource":{"shape":"String"}, "Description":{"shape":"ResourceDescription"}, + "DataSource":{"shape":"String"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." }, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -3167,13 +3360,13 @@ "type":"structure", "required":["TrackerName"], "members":{ - "MaxResults":{"shape":"ListTrackerConsumersRequestMaxResultsInteger"}, - "NextToken":{"shape":"Token"}, "TrackerName":{ "shape":"ResourceName", "location":"uri", "locationName":"TrackerName" - } + }, + "MaxResults":{"shape":"ListTrackerConsumersRequestMaxResultsInteger"}, + "NextToken":{"shape":"Token"} } }, "ListTrackerConsumersRequestMaxResultsInteger":{ @@ -3211,56 +3404,136 @@ "NextToken":{"shape":"Token"} } }, - "ListTrackersResponseEntry":{ + "ListTrackersResponseEntry":{ + "type":"structure", + "required":[ + "TrackerName", + "Description", + "CreateTime", + "UpdateTime" + ], + "members":{ + "TrackerName":{"shape":"ResourceName"}, + "Description":{"shape":"ResourceDescription"}, + "PricingPlan":{ + "shape":"PricingPlan", + "deprecated":true, + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + }, + "PricingPlanDataSource":{ + "shape":"String", + "deprecated":true, + "deprecatedMessage":"Deprecated. Unused." + }, + "CreateTime":{"shape":"Timestamp"}, + "UpdateTime":{"shape":"Timestamp"} + } + }, + "ListTrackersResponseEntryList":{ + "type":"list", + "member":{"shape":"ListTrackersResponseEntry"} + }, + "LteCellDetails":{ + "type":"structure", + "required":[ + "CellId", + "Mcc", + "Mnc" + ], + "members":{ + "CellId":{"shape":"EutranCellId"}, + "Mcc":{"shape":"LteCellDetailsMccInteger"}, + "Mnc":{"shape":"LteCellDetailsMncInteger"}, + "LocalId":{"shape":"LteLocalId"}, + "NetworkMeasurements":{"shape":"LteCellDetailsNetworkMeasurementsList"}, + "TimingAdvance":{"shape":"LteCellDetailsTimingAdvanceInteger"}, + "NrCapable":{"shape":"Boolean"}, + "Rsrp":{"shape":"Rsrp"}, + "Rsrq":{"shape":"Rsrq"}, + "Tac":{"shape":"LteCellDetailsTacInteger"} + } + }, + "LteCellDetailsMccInteger":{ + "type":"integer", + "box":true, + "max":999, + "min":200 + }, + "LteCellDetailsMncInteger":{ + "type":"integer", + "box":true, + "max":999, + "min":0 + }, + "LteCellDetailsNetworkMeasurementsList":{ + "type":"list", + "member":{"shape":"LteNetworkMeasurements"}, + "max":32, + "min":1 + }, + "LteCellDetailsTacInteger":{ + "type":"integer", + "box":true, + "max":65535, + "min":0 + }, + "LteCellDetailsTimingAdvanceInteger":{ + "type":"integer", + "box":true, + "max":1282, + "min":0 + }, + "LteLocalId":{ + "type":"structure", + "required":[ + "Earfcn", + "Pci" + ], + "members":{ + "Earfcn":{"shape":"Earfcn"}, + "Pci":{"shape":"Pci"} + } + }, + "LteNetworkMeasurements":{ "type":"structure", "required":[ - "CreateTime", - "Description", - "TrackerName", - "UpdateTime" + "Earfcn", + "CellId", + "Pci" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, - "Description":{"shape":"ResourceDescription"}, - "PricingPlan":{ - "shape":"PricingPlan", - "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." - }, - "PricingPlanDataSource":{ - "shape":"String", - "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." - }, - "TrackerName":{"shape":"ResourceName"}, - "UpdateTime":{"shape":"Timestamp"} + "Earfcn":{"shape":"Earfcn"}, + "CellId":{"shape":"EutranCellId"}, + "Pci":{"shape":"Pci"}, + "Rsrp":{"shape":"Rsrp"}, + "Rsrq":{"shape":"Rsrq"} } }, - "ListTrackersResponseEntryList":{ - "type":"list", - "member":{"shape":"ListTrackersResponseEntry"} - }, "MapConfiguration":{ "type":"structure", "required":["Style"], "members":{ - "CustomLayers":{"shape":"CustomLayerList"}, + "Style":{"shape":"MapStyle"}, "PoliticalView":{"shape":"CountryCode3"}, - "Style":{"shape":"MapStyle"} + "CustomLayers":{"shape":"CustomLayerList"} } }, "MapConfigurationUpdate":{ "type":"structure", "members":{ - "CustomLayers":{"shape":"CustomLayerList"}, - "PoliticalView":{"shape":"CountryCode3OrEmpty"} + "PoliticalView":{"shape":"CountryCode3OrEmpty"}, + "CustomLayers":{"shape":"CustomLayerList"} } }, "MapStyle":{ "type":"string", "max":100, "min":1, - "pattern":"^[-._\\w]+$" + "pattern":"[-._\\w]+" + }, + "NearestDistance":{ + "type":"double", + "min":0 }, "OptimizationMode":{ "type":"string", @@ -3269,27 +3542,32 @@ "ShortestRoute" ] }, + "Pci":{ + "type":"integer", + "max":503, + "min":0 + }, "Place":{ "type":"structure", "required":["Geometry"], "members":{ - "AddressNumber":{"shape":"String"}, - "Categories":{"shape":"PlaceCategoryList"}, - "Country":{"shape":"String"}, - "Geometry":{"shape":"PlaceGeometry"}, - "Interpolated":{"shape":"Boolean"}, "Label":{"shape":"String"}, - "Municipality":{"shape":"String"}, - "Neighborhood":{"shape":"String"}, - "PostalCode":{"shape":"String"}, - "Region":{"shape":"String"}, + "Geometry":{"shape":"PlaceGeometry"}, + "AddressNumber":{"shape":"String"}, "Street":{"shape":"String"}, - "SubMunicipality":{"shape":"String"}, + "Neighborhood":{"shape":"String"}, + "Municipality":{"shape":"String"}, "SubRegion":{"shape":"String"}, - "SupplementalCategories":{"shape":"PlaceSupplementalCategoryList"}, + "Region":{"shape":"String"}, + "Country":{"shape":"String"}, + "PostalCode":{"shape":"String"}, + "Interpolated":{"shape":"Boolean"}, "TimeZone":{"shape":"TimeZone"}, + "UnitType":{"shape":"String"}, "UnitNumber":{"shape":"String"}, - "UnitType":{"shape":"String"} + "Categories":{"shape":"PlaceCategoryList"}, + "SupplementalCategories":{"shape":"PlaceSupplementalCategoryList"}, + "SubMunicipality":{"shape":"String"} } }, "PlaceCategory":{ @@ -3352,7 +3630,7 @@ "PositionalAccuracyHorizontalDouble":{ "type":"double", "box":true, - "max":10000, + "max":10000000, "min":0 }, "PricingPlan":{ @@ -3399,20 +3677,20 @@ "location":"uri", "locationName":"GeofenceId" }, - "GeofenceProperties":{"shape":"PropertyMap"}, - "Geometry":{"shape":"GeofenceGeometry"} + "Geometry":{"shape":"GeofenceGeometry"}, + "GeofenceProperties":{"shape":"PropertyMap"} } }, "PutGeofenceResponse":{ "type":"structure", "required":[ - "CreateTime", "GeofenceId", + "CreateTime", "UpdateTime" ], "members":{ - "CreateTime":{"shape":"Timestamp"}, "GeofenceId":{"shape":"Id"}, + "CreateTime":{"shape":"Timestamp"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -3420,7 +3698,7 @@ "type":"string", "max":253, "min":0, - "pattern":"^([$\\-._+!*\\x{60}(),;/?:@=&\\w]|%([0-9a-fA-F?]{2}|[0-9a-fA-F?]?[*]))+$" + "pattern":"([$\\-._+!*\\x{60}(),;/?:@=&\\w]|%([0-9a-fA-F?]{2}|[0-9a-fA-F?]?[*]))+" }, "ResourceDescription":{ "type":"string", @@ -3431,7 +3709,7 @@ "type":"string", "max":100, "min":1, - "pattern":"^[-._\\w]+$" + "pattern":"[-._\\w]+" }, "ResourceNotFoundException":{ "type":"structure", @@ -3493,15 +3771,27 @@ "type":"list", "member":{"shape":"RouteMatrixEntry"} }, + "Rsrp":{ + "type":"integer", + "box":true, + "max":-44, + "min":-140 + }, + "Rsrq":{ + "type":"float", + "box":true, + "max":-3, + "min":-19.5 + }, "SearchForPositionResult":{ "type":"structure", "required":[ - "Distance", - "Place" + "Place", + "Distance" ], "members":{ - "Distance":{"shape":"SearchForPositionResultDistanceDouble"}, "Place":{"shape":"Place"}, + "Distance":{"shape":"SearchForPositionResultDistanceDouble"}, "PlaceId":{"shape":"PlaceId"} } }, @@ -3518,10 +3808,10 @@ "type":"structure", "required":["Text"], "members":{ - "Categories":{"shape":"PlaceCategoryList"}, + "Text":{"shape":"String"}, "PlaceId":{"shape":"PlaceId"}, - "SupplementalCategories":{"shape":"PlaceSupplementalCategoryList"}, - "Text":{"shape":"String"} + "Categories":{"shape":"PlaceCategoryList"}, + "SupplementalCategories":{"shape":"PlaceSupplementalCategoryList"} } }, "SearchForSuggestionsResultList":{ @@ -3532,10 +3822,10 @@ "type":"structure", "required":["Place"], "members":{ - "Distance":{"shape":"SearchForTextResultDistanceDouble"}, "Place":{"shape":"Place"}, - "PlaceId":{"shape":"PlaceId"}, - "Relevance":{"shape":"SearchForTextResultRelevanceDouble"} + "Distance":{"shape":"SearchForTextResultDistanceDouble"}, + "Relevance":{"shape":"SearchForTextResultRelevanceDouble"}, + "PlaceId":{"shape":"PlaceId"} } }, "SearchForTextResultDistanceDouble":{ @@ -3565,38 +3855,38 @@ "location":"uri", "locationName":"IndexName" }, + "Position":{"shape":"Position"}, + "MaxResults":{"shape":"PlaceIndexSearchResultLimit"}, + "Language":{"shape":"LanguageTag"}, "Key":{ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "Language":{"shape":"LanguageTag"}, - "MaxResults":{"shape":"PlaceIndexSearchResultLimit"}, - "Position":{"shape":"Position"} + } } }, "SearchPlaceIndexForPositionResponse":{ "type":"structure", "required":[ - "Results", - "Summary" + "Summary", + "Results" ], "members":{ - "Results":{"shape":"SearchForPositionResultList"}, - "Summary":{"shape":"SearchPlaceIndexForPositionSummary"} + "Summary":{"shape":"SearchPlaceIndexForPositionSummary"}, + "Results":{"shape":"SearchForPositionResultList"} } }, "SearchPlaceIndexForPositionSummary":{ "type":"structure", "required":[ - "DataSource", - "Position" + "Position", + "DataSource" ], "members":{ - "DataSource":{"shape":"String"}, - "Language":{"shape":"LanguageTag"}, + "Position":{"shape":"Position"}, "MaxResults":{"shape":"PlaceIndexSearchResultLimit"}, - "Position":{"shape":"Position"} + "DataSource":{"shape":"String"}, + "Language":{"shape":"LanguageTag"} } }, "SearchPlaceIndexForSuggestionsRequest":{ @@ -3606,23 +3896,23 @@ "Text" ], "members":{ - "BiasPosition":{"shape":"Position"}, - "FilterBBox":{"shape":"BoundingBox"}, - "FilterCategories":{"shape":"FilterPlaceCategoryList"}, - "FilterCountries":{"shape":"CountryCodeList"}, "IndexName":{ "shape":"ResourceName", "location":"uri", "locationName":"IndexName" }, + "Text":{"shape":"SearchPlaceIndexForSuggestionsRequestTextString"}, + "BiasPosition":{"shape":"Position"}, + "FilterBBox":{"shape":"BoundingBox"}, + "FilterCountries":{"shape":"CountryCodeList"}, + "MaxResults":{"shape":"SearchPlaceIndexForSuggestionsRequestMaxResultsInteger"}, + "Language":{"shape":"LanguageTag"}, + "FilterCategories":{"shape":"FilterPlaceCategoryList"}, "Key":{ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "Language":{"shape":"LanguageTag"}, - "MaxResults":{"shape":"SearchPlaceIndexForSuggestionsRequestMaxResultsInteger"}, - "Text":{"shape":"SearchPlaceIndexForSuggestionsRequestTextString"} + } } }, "SearchPlaceIndexForSuggestionsRequestMaxResultsInteger":{ @@ -3640,29 +3930,29 @@ "SearchPlaceIndexForSuggestionsResponse":{ "type":"structure", "required":[ - "Results", - "Summary" + "Summary", + "Results" ], "members":{ - "Results":{"shape":"SearchForSuggestionsResultList"}, - "Summary":{"shape":"SearchPlaceIndexForSuggestionsSummary"} + "Summary":{"shape":"SearchPlaceIndexForSuggestionsSummary"}, + "Results":{"shape":"SearchForSuggestionsResultList"} } }, "SearchPlaceIndexForSuggestionsSummary":{ "type":"structure", "required":[ - "DataSource", - "Text" + "Text", + "DataSource" ], "members":{ + "Text":{"shape":"SensitiveString"}, "BiasPosition":{"shape":"Position"}, - "DataSource":{"shape":"String"}, "FilterBBox":{"shape":"BoundingBox"}, - "FilterCategories":{"shape":"FilterPlaceCategoryList"}, "FilterCountries":{"shape":"CountryCodeList"}, - "Language":{"shape":"LanguageTag"}, "MaxResults":{"shape":"Integer"}, - "Text":{"shape":"SensitiveString"} + "DataSource":{"shape":"String"}, + "Language":{"shape":"LanguageTag"}, + "FilterCategories":{"shape":"FilterPlaceCategoryList"} } }, "SearchPlaceIndexForTextRequest":{ @@ -3672,23 +3962,23 @@ "Text" ], "members":{ - "BiasPosition":{"shape":"Position"}, - "FilterBBox":{"shape":"BoundingBox"}, - "FilterCategories":{"shape":"FilterPlaceCategoryList"}, - "FilterCountries":{"shape":"CountryCodeList"}, "IndexName":{ "shape":"ResourceName", "location":"uri", "locationName":"IndexName" }, + "Text":{"shape":"SearchPlaceIndexForTextRequestTextString"}, + "BiasPosition":{"shape":"Position"}, + "FilterBBox":{"shape":"BoundingBox"}, + "FilterCountries":{"shape":"CountryCodeList"}, + "MaxResults":{"shape":"PlaceIndexSearchResultLimit"}, + "Language":{"shape":"LanguageTag"}, + "FilterCategories":{"shape":"FilterPlaceCategoryList"}, "Key":{ "shape":"ApiKey", "location":"querystring", "locationName":"key" - }, - "Language":{"shape":"LanguageTag"}, - "MaxResults":{"shape":"PlaceIndexSearchResultLimit"}, - "Text":{"shape":"SearchPlaceIndexForTextRequestTextString"} + } } }, "SearchPlaceIndexForTextRequestTextString":{ @@ -3700,30 +3990,30 @@ "SearchPlaceIndexForTextResponse":{ "type":"structure", "required":[ - "Results", - "Summary" + "Summary", + "Results" ], "members":{ - "Results":{"shape":"SearchForTextResultList"}, - "Summary":{"shape":"SearchPlaceIndexForTextSummary"} + "Summary":{"shape":"SearchPlaceIndexForTextSummary"}, + "Results":{"shape":"SearchForTextResultList"} } }, "SearchPlaceIndexForTextSummary":{ "type":"structure", "required":[ - "DataSource", - "Text" + "Text", + "DataSource" ], "members":{ + "Text":{"shape":"SensitiveString"}, "BiasPosition":{"shape":"Position"}, - "DataSource":{"shape":"String"}, "FilterBBox":{"shape":"BoundingBox"}, - "FilterCategories":{"shape":"FilterPlaceCategoryList"}, "FilterCountries":{"shape":"CountryCodeList"}, - "Language":{"shape":"LanguageTag"}, "MaxResults":{"shape":"PlaceIndexSearchResultLimit"}, "ResultBBox":{"shape":"BoundingBox"}, - "Text":{"shape":"SensitiveString"} + "DataSource":{"shape":"String"}, + "Language":{"shape":"LanguageTag"}, + "FilterCategories":{"shape":"FilterPlaceCategoryList"} } }, "SensitiveString":{ @@ -3745,6 +4035,13 @@ }, "exception":true }, + "SpeedUnit":{ + "type":"string", + "enum":[ + "KilometersPerHour", + "MilesPerHour" + ] + }, "Status":{ "type":"string", "enum":[ @@ -3755,17 +4052,17 @@ "Step":{ "type":"structure", "required":[ - "Distance", - "DurationSeconds", + "StartPosition", "EndPosition", - "StartPosition" + "Distance", + "DurationSeconds" ], "members":{ + "StartPosition":{"shape":"Position"}, + "EndPosition":{"shape":"Position"}, "Distance":{"shape":"StepDistanceDouble"}, "DurationSeconds":{"shape":"StepDurationSecondsDouble"}, - "EndPosition":{"shape":"Position"}, - "GeometryOffset":{"shape":"StepGeometryOffsetInteger"}, - "StartPosition":{"shape":"Position"} + "GeometryOffset":{"shape":"StepGeometryOffsetInteger"} } }, "StepDistanceDouble":{ @@ -3792,7 +4089,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z+-=._:/]+$" + "pattern":"[a-zA-Z+-=._:/]+" }, "TagKeys":{ "type":"list", @@ -3831,7 +4128,7 @@ "type":"string", "max":256, "min":0, - "pattern":"^[A-Za-z0-9 _=@:.+-/]*$" + "pattern":"[A-Za-z0-9 _=@:.+-/]*" }, "ThrottlingException":{ "type":"structure", @@ -3885,10 +4182,10 @@ "TruckDimensions":{ "type":"structure", "members":{ - "Height":{"shape":"TruckDimensionsHeightDouble"}, "Length":{"shape":"TruckDimensionsLengthDouble"}, - "Unit":{"shape":"DimensionUnit"}, - "Width":{"shape":"TruckDimensionsWidthDouble"} + "Height":{"shape":"TruckDimensionsHeightDouble"}, + "Width":{"shape":"TruckDimensionsWidthDouble"}, + "Unit":{"shape":"DimensionUnit"} } }, "TruckDimensionsHeightDouble":{ @@ -3951,7 +4248,6 @@ "location":"uri", "locationName":"CollectionName" }, - "Description":{"shape":"ResourceDescription"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, @@ -3961,19 +4257,20 @@ "shape":"String", "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed." - } + }, + "Description":{"shape":"ResourceDescription"} } }, "UpdateGeofenceCollectionResponse":{ "type":"structure", "required":[ - "CollectionArn", "CollectionName", + "CollectionArn", "UpdateTime" ], "members":{ - "CollectionArn":{"shape":"Arn"}, "CollectionName":{"shape":"ResourceName"}, + "CollectionArn":{"shape":"Arn"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -3981,15 +4278,15 @@ "type":"structure", "required":["KeyName"], "members":{ - "Description":{"shape":"ResourceDescription"}, - "ExpireTime":{"shape":"Timestamp"}, - "ForceUpdate":{"shape":"Boolean"}, "KeyName":{ "shape":"ResourceName", "location":"uri", "locationName":"KeyName" }, + "Description":{"shape":"ResourceDescription"}, + "ExpireTime":{"shape":"Timestamp"}, "NoExpiry":{"shape":"Boolean"}, + "ForceUpdate":{"shape":"Boolean"}, "Restrictions":{"shape":"ApiKeyRestrictions"} } }, @@ -4010,8 +4307,6 @@ "type":"structure", "required":["MapName"], "members":{ - "ConfigurationUpdate":{"shape":"MapConfigurationUpdate"}, - "Description":{"shape":"ResourceDescription"}, "MapName":{ "shape":"ResourceName", "location":"uri", @@ -4021,19 +4316,21 @@ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." - } + }, + "Description":{"shape":"ResourceDescription"}, + "ConfigurationUpdate":{"shape":"MapConfigurationUpdate"} } }, "UpdateMapResponse":{ "type":"structure", "required":[ - "MapArn", "MapName", + "MapArn", "UpdateTime" ], "members":{ - "MapArn":{"shape":"GeoArn"}, "MapName":{"shape":"ResourceName"}, + "MapArn":{"shape":"GeoArn"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -4041,8 +4338,6 @@ "type":"structure", "required":["IndexName"], "members":{ - "DataSourceConfiguration":{"shape":"DataSourceConfiguration"}, - "Description":{"shape":"ResourceDescription"}, "IndexName":{ "shape":"ResourceName", "location":"uri", @@ -4052,19 +4347,21 @@ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." - } + }, + "Description":{"shape":"ResourceDescription"}, + "DataSourceConfiguration":{"shape":"DataSourceConfiguration"} } }, "UpdatePlaceIndexResponse":{ "type":"structure", "required":[ - "IndexArn", "IndexName", + "IndexArn", "UpdateTime" ], "members":{ - "IndexArn":{"shape":"GeoArn"}, "IndexName":{"shape":"ResourceName"}, + "IndexArn":{"shape":"GeoArn"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -4077,24 +4374,24 @@ "location":"uri", "locationName":"CalculatorName" }, - "Description":{"shape":"ResourceDescription"}, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." - } + }, + "Description":{"shape":"ResourceDescription"} } }, "UpdateRouteCalculatorResponse":{ "type":"structure", "required":[ - "CalculatorArn", "CalculatorName", + "CalculatorArn", "UpdateTime" ], "members":{ - "CalculatorArn":{"shape":"GeoArn"}, "CalculatorName":{"shape":"ResourceName"}, + "CalculatorArn":{"shape":"GeoArn"}, "UpdateTime":{"shape":"Timestamp"} } }, @@ -4102,10 +4399,11 @@ "type":"structure", "required":["TrackerName"], "members":{ - "Description":{"shape":"ResourceDescription"}, - "EventBridgeEnabled":{"shape":"Boolean"}, - "KmsKeyEnableGeospatialQueries":{"shape":"Boolean"}, - "PositionFiltering":{"shape":"PositionFiltering"}, + "TrackerName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"TrackerName" + }, "PricingPlan":{ "shape":"PricingPlan", "deprecated":true, @@ -4116,38 +4414,37 @@ "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed." }, - "TrackerName":{ - "shape":"ResourceName", - "location":"uri", - "locationName":"TrackerName" - } + "Description":{"shape":"ResourceDescription"}, + "PositionFiltering":{"shape":"PositionFiltering"}, + "EventBridgeEnabled":{"shape":"Boolean"}, + "KmsKeyEnableGeospatialQueries":{"shape":"Boolean"} } }, "UpdateTrackerResponse":{ "type":"structure", "required":[ - "TrackerArn", "TrackerName", + "TrackerArn", "UpdateTime" ], "members":{ - "TrackerArn":{"shape":"Arn"}, "TrackerName":{"shape":"ResourceName"}, + "TrackerArn":{"shape":"Arn"}, "UpdateTime":{"shape":"Timestamp"} } }, + "Uuid":{ + "type":"string", + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, "ValidationException":{ "type":"structure", "required":[ - "FieldList", "Message", - "Reason" + "Reason", + "FieldList" ], "members":{ - "FieldList":{ - "shape":"ValidationExceptionFieldList", - "locationName":"fieldList" - }, "Message":{ "shape":"String", "locationName":"message" @@ -4155,6 +4452,10 @@ "Reason":{ "shape":"ValidationExceptionReason", "locationName":"reason" + }, + "FieldList":{ + "shape":"ValidationExceptionFieldList", + "locationName":"fieldList" } }, "error":{ @@ -4166,17 +4467,17 @@ "ValidationExceptionField":{ "type":"structure", "required":[ - "Message", - "Name" + "Name", + "Message" ], "members":{ - "Message":{ - "shape":"String", - "locationName":"message" - }, "Name":{ "shape":"String", "locationName":"name" + }, + "Message":{ + "shape":"String", + "locationName":"message" } } }, @@ -4200,6 +4501,66 @@ "Kilograms", "Pounds" ] + }, + "VerifyDevicePositionRequest":{ + "type":"structure", + "required":[ + "TrackerName", + "DeviceState" + ], + "members":{ + "TrackerName":{ + "shape":"ResourceName", + "location":"uri", + "locationName":"TrackerName" + }, + "DeviceState":{"shape":"DeviceState"}, + "DistanceUnit":{"shape":"DistanceUnit"} + } + }, + "VerifyDevicePositionResponse":{ + "type":"structure", + "required":[ + "InferredState", + "DeviceId", + "SampleTime", + "ReceivedTime", + "DistanceUnit" + ], + "members":{ + "InferredState":{"shape":"InferredState"}, + "DeviceId":{"shape":"Id"}, + "SampleTime":{"shape":"Timestamp"}, + "ReceivedTime":{"shape":"Timestamp"}, + "DistanceUnit":{"shape":"DistanceUnit"} + } + }, + "WiFiAccessPoint":{ + "type":"structure", + "required":[ + "MacAddress", + "Rss" + ], + "members":{ + "MacAddress":{"shape":"WiFiAccessPointMacAddressString"}, + "Rss":{"shape":"WiFiAccessPointRssInteger"} + } + }, + "WiFiAccessPointList":{ + "type":"list", + "member":{"shape":"WiFiAccessPoint"} + }, + "WiFiAccessPointMacAddressString":{ + "type":"string", + "max":17, + "min":12, + "pattern":"([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})" + }, + "WiFiAccessPointRssInteger":{ + "type":"integer", + "box":true, + "max":0, + "min":-128 } } } diff --git a/models/apis/location/2020-11-19/docs-2.json b/models/apis/location/2020-11-19/docs-2.json index ec653c60981..1a25487f62c 100644 --- a/models/apis/location/2020-11-19/docs-2.json +++ b/models/apis/location/2020-11-19/docs-2.json @@ -30,9 +30,10 @@ "DescribeRouteCalculator": "Retrieves the route calculator resource details.
", "DescribeTracker": "Retrieves the tracker resource details.
", "DisassociateTrackerConsumer": "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:
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.
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
Retrieves the geofence details from a geofence collection.
", + "GetGeofence": "Retrieves the geofence details from a geofence collection.
The returned geometry will always match the geometry format used when the geofence was created.
Retrieves glyphs used to display labels on a map.
", "GetMapSprites": "Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
", "GetMapStyleDescriptor": "Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
", @@ -59,7 +60,8 @@ "UpdateMap": "Updates the specified properties of a given map resource.
", "UpdatePlaceIndex": "Updates the specified properties of a given place index resource.
", "UpdateRouteCalculator": "Updates the specified properties for a given route calculator resource.
", - "UpdateTracker": "Updates the specified properties of a given tracker resource.
" + "UpdateTracker": "Updates the specified properties of a given tracker resource.
", + "VerifyDevicePosition": "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.
" }, "shapes": { "AccessDeniedException": { @@ -159,6 +161,12 @@ "refs": { } }, + "Base64EncodedGeobuf": { + "base": null, + "refs": { + "GeofenceGeometry$Geobuf": "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.
" + } + }, "BatchDeleteDevicePositionHistoryError": { "base": "Contains the tracker resource details.
", "refs": { @@ -393,9 +401,12 @@ "DeleteKeyRequest$ForceDelete": "ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.
Valid values: true, or false.
Required: No
This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.
Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
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 KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.
Indicates if the device is located within the geofence.
", + "InferredState$ProxyDetected": "Indicates if a proxy was used.
", + "LteCellDetails$NrCapable": "Indicates whether the LTE object is capable of supporting NR (new radio).
", "Place$Interpolated": " True if the result is interpolated from other known places.
False if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns 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.
The boolean flag to be included for updating ExpireTime or Restrictions details.
Must be set to true to update an API key resource that has been used in the past 7 days.
False if force update is not preferred
Default value: False
Whether the API key should expire. Set to true to set the API key to have no expiration time.
The boolean flag to be included for updating ExpireTime or Restrictions details.
Must be set to true to update an API key resource that has been used in the past 7 days.
False if force update is not preferred
Default value: False
Whether to enable position UPDATE events from this tracker to be sent to EventBridge.
You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.
Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
This parameter is only used if you are using a KMS customer managed key.
" } @@ -511,6 +522,18 @@ "CalculateRouteRequest$TruckModeOptions": "Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
The cellular network communication infrastructure that the device uses.
", + "refs": { + "DeviceState$CellSignals": "The cellular network infrastructure that the device is connected to.
" + } + }, + "CellSignalsLteCellDetailsList": { + "base": null, + "refs": { + "CellSignals$LteCellDetails": "Information about the Long-Term Evolution (LTE) network the device is connected to.
" + } + }, "Circle": { "base": "A circle on the earth, as defined by a center point and a radius.
", "refs": { @@ -522,15 +545,10 @@ "refs": { } }, - "CountryCode": { - "base": null, - "refs": { - "CountryCodeList$member": null - } - }, "CountryCode3": { "base": null, "refs": { + "CountryCodeList$member": null, "MapConfiguration$PoliticalView": "Specifies the political view for the style. Leave unset to not use a political view, or, for styles that support specific political views, you can choose a view, such as IND for the Indian view.
Default is unset.
Not all map resources or styles support political view styles. See Political views for more information.
Specifies the 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 unset.
Currenlty only VectorEsriNavigation supports CustomLayers. For more information, see Custom Layers.
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 unset.
Currenlty only VectorEsriNavigation supports CustomLayers. For more information, see Custom Layers.
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 unset.
Not all map resources or styles support custom layers. See Custom Layers 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 unset.
Not all map resources or styles support custom layers. See Custom Layers for more information.
The device's position, IP address, and Wi-Fi access points.
", + "refs": { + "VerifyDevicePositionRequest$DeviceState": "The device's state, including position, IP address, cell signals and Wi-Fi access points.
" + } + }, + "DeviceStateIpv4AddressString": { + "base": null, + "refs": { + "DeviceState$Ipv4Address": "The device's Ipv4 address.
" + } + }, "DimensionUnit": { "base": null, "refs": { @@ -798,7 +828,11 @@ "CalculateRouteMatrixRequest$DistanceUnit": "Set the unit system to specify the distance.
Default Value: Kilometers
The unit of measurement for route distances.
", "CalculateRouteRequest$DistanceUnit": "Set the unit system to specify the distance.
Default Value: Kilometers
The unit of measurement for route distances.
" + "CalculateRouteSummary$DistanceUnit": "The unit of measurement for route distances.
", + "ForecastGeofenceEventsRequest$DistanceUnit": "The distance unit used for the 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.
Default Value: Kilometers
The distance unit for the forecasted events.
", + "VerifyDevicePositionRequest$DistanceUnit": "The distance unit for the verification request.
Default Value: Kilometers
The distance unit for the verification response.
" } }, "Double": { @@ -806,9 +840,24 @@ "refs": { "BoundingBox$member": null, "Circle$Radius": "The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
", + "InferredState$DeviationDistance": "The distance between the inferred position and the device's self-reported position.
", "Position$member": null } }, + "Earfcn": { + "base": null, + "refs": { + "LteLocalId$Earfcn": "E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).
", + "LteNetworkMeasurements$Earfcn": "E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).
" + } + }, + "EutranCellId": { + "base": null, + "refs": { + "LteCellDetails$CellId": "The E-UTRAN Cell Identifier (ECI).
", + "LteNetworkMeasurements$CellId": "E-UTRAN Cell Identifier (ECI).
" + } + }, "FilterPlaceCategoryList": { "base": null, "refs": { @@ -818,10 +867,61 @@ "SearchPlaceIndexForTextSummary$FilterCategories": "The optional category filter specified in the request.
" } }, + "ForecastGeofenceEventsDeviceState": { + "base": "The device's position, IP address, and WiFi access points.
", + "refs": { + "ForecastGeofenceEventsRequest$DeviceState": "The device's state, including current position and speed.
" + } + }, + "ForecastGeofenceEventsDeviceStateSpeedDouble": { + "base": null, + "refs": { + "ForecastGeofenceEventsDeviceState$Speed": "The device's speed.
" + } + }, + "ForecastGeofenceEventsRequest": { + "base": null, + "refs": { + } + }, + "ForecastGeofenceEventsRequestMaxResultsInteger": { + "base": null, + "refs": { + "ForecastGeofenceEventsRequest$MaxResults": "An optional limit for the number of resources returned in a single call.
Default value: 20
Specifies the time horizon in minutes for the forecasted events.
" + } + }, + "ForecastGeofenceEventsResponse": { + "base": null, + "refs": { + } + }, + "ForecastedEvent": { + "base": "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.
", + "refs": { + "ForecastedEventsList$member": null + } + }, + "ForecastedEventsList": { + "base": null, + "refs": { + "ForecastGeofenceEventsResponse$ForecastedEvents": "The list of forecasted events.
" + } + }, + "ForecastedGeofenceEventType": { + "base": null, + "refs": { + "ForecastedEvent$EventType": "The event type, forecasting three states for which a device can be in relative to a geofence:
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.
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:map/ExampleMap
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.
Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator
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.
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 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.
Contains the geofence geometry details describing a polygon or a circle.
", "ListGeofenceResponseEntry$Geometry": "Contains the geofence geometry details describing a polygon or a circle.
", - "PutGeofenceRequest$Geometry": "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.
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.
The device associated with the failed location update.
", "DevicePosition$DeviceId": "The device whose position you retrieved.
", "DevicePositionUpdate$DeviceId": "The device associated to the position update.
", + "DeviceState$DeviceId": "The device identifier.
", + "ForecastedEvent$GeofenceId": "The geofence identifier pertaining to the forecasted event.
", "GetDevicePositionHistoryRequest$DeviceId": "The device whose position history you want to retrieve.
", "GetDevicePositionRequest$DeviceId": "The device whose position you want to retrieve.
", "GetDevicePositionResponse$DeviceId": "The device whose position you retrieved.
", @@ -982,7 +1090,14 @@ "ListDevicePositionsResponseEntry$DeviceId": "The ID of the device for this position.
", "ListGeofenceResponseEntry$GeofenceId": "The geofence identifier.
", "PutGeofenceRequest$GeofenceId": "An identifier for the geofence. For example, ExampleGeofence-1.
The geofence identifier entered in the request.
" + "PutGeofenceResponse$GeofenceId": "The geofence identifier entered in the request.
", + "VerifyDevicePositionResponse$DeviceId": "The device identifier.
" + } + }, + "InferredState": { + "base": "The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.
", + "refs": { + "VerifyDevicePositionResponse$InferredState": "The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.
" } }, "Integer": { @@ -1024,6 +1139,15 @@ "SearchPlaceIndexForTextSummary$Language": "The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
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: null
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.
", + "ListGeofencesRequest$NextToken": "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: null
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.
" + } + }, "Leg": { "base": "Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
Contains the geofence collection details.
", + "base": "Contains the geofence collection details.
The returned geometry will always match the geometry format used when the geofence was created.
Contains a list of geofences stored in a given geofence collection.
", + "base": "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.
Contains tracker resources in your Amazon Web Services account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
" } }, + "LteCellDetails": { + "base": "Details about the Long-Term Evolution (LTE) network.
", + "refs": { + "CellSignalsLteCellDetailsList$member": null + } + }, + "LteCellDetailsMccInteger": { + "base": null, + "refs": { + "LteCellDetails$Mcc": "The Mobile Country Code (MCC).
" + } + }, + "LteCellDetailsMncInteger": { + "base": null, + "refs": { + "LteCellDetails$Mnc": "The Mobile Network Code (MNC)
" + } + }, + "LteCellDetailsNetworkMeasurementsList": { + "base": null, + "refs": { + "LteCellDetails$NetworkMeasurements": "The network measurements.
" + } + }, + "LteCellDetailsTacInteger": { + "base": null, + "refs": { + "LteCellDetails$Tac": "LTE Tracking Area Code (TAC).
" + } + }, + "LteCellDetailsTimingAdvanceInteger": { + "base": null, + "refs": { + "LteCellDetails$TimingAdvance": "Timing Advance (TA).
" + } + }, + "LteLocalId": { + "base": "LTE local identification information (local ID).
", + "refs": { + "LteCellDetails$LocalId": "The LTE local identification information (local ID).
" + } + }, + "LteNetworkMeasurements": { + "base": "LTE network measurements.
", + "refs": { + "LteCellDetailsNetworkMeasurementsList$member": null + } + }, "MapConfiguration": { "base": "Specifies the map tile style selected from an available provider.
", "refs": { @@ -1339,7 +1511,13 @@ "MapStyle": { "base": null, "refs": { - "MapConfiguration$Style": "Specifies the map style selected from an available data provider.
Valid Esri map styles:
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.
Valid HERE Technologies map styles:
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.
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.
VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.
The VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin has been deprecated, but will continue to work in applications that use it.
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.
Valid GrabMaps map styles:
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.
VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region (ap-southeast-1). For more information, see GrabMaps countries and area covered.
Valid Open Data map styles:
VectorOpenDataStandardLight – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataVisualizationLight – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.
VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.
VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.
VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
VectorEsriStreets – The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
VectorEsriNavigation – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid HERE Technologies map styles:
VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.
The VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin has been deprecated, but will continue to work in applications that use it.
VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.
VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.
RasterHereExploreSatellite – A global map containing high resolution satellite imagery.
HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid GrabMaps map styles:
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.
VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region (ap-southeast-1). For more information, see GrabMaps countries and area covered.
Valid Open Data map styles:
VectorOpenDataStandardLight – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataVisualizationLight – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.
VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.
The closest distance from the device's position to the geofence.
" } }, "OptimizationMode": { @@ -1348,6 +1526,13 @@ "CalculateRouteRequest$OptimizeFor": "Specifies the distance to optimize for when calculating a route.
" } }, + "Pci": { + "base": null, + "refs": { + "LteLocalId$Pci": "Physical Cell ID (PCI).
", + "LteNetworkMeasurements$Pci": "Physical Cell ID (PCI).
" + } + }, "Place": { "base": "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.
", "refs": { @@ -1379,9 +1564,9 @@ "PlaceId": { "base": null, "refs": { - "GetPlaceRequest$PlaceId": "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 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.
The identifier of the place to find.
", "SearchForPositionResult$PlaceId": "The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.
The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.
The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.
For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
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 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.
The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.
The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.
For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.
A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].
The last known device position.
", "DevicePositionUpdate$Position": "The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].
The last known device position.
", + "ForecastGeofenceEventsDeviceState$Position": "The device's position.
", "GetDevicePositionResponse$Position": "The last known device position.
", - "Leg$EndPosition": "The terminating position of the leg. Follows the format [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
The device position inferred by the provided position, IP address, cellular signals, and Wi-Fi- access points.
", "Leg$StartPosition": "The starting position of the leg. Follows the format [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a nearby road.
The terminating position of the leg. Follows the format [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
The last known device position. Empty if no positions currently stored.
", @@ -1433,8 +1621,8 @@ "SearchPlaceIndexForSuggestionsSummary$BiasPosition": "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, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
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, [-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.
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, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
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.
", - "Step$StartPosition": "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.
" + "Step$StartPosition": "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.
", + "Step$EndPosition": "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.
" } }, "PositionFiltering": { @@ -1450,7 +1638,9 @@ "refs": { "DevicePosition$Accuracy": "The accuracy of the device position.
", "DevicePositionUpdate$Accuracy": "The accuracy of the device position.
", + "DeviceState$Accuracy": null, "GetDevicePositionResponse$Accuracy": "The accuracy of the device position.
", + "InferredState$Accuracy": "The level of certainty of the inferred position.
", "ListDevicePositionsResponseEntry$Accuracy": "The accuracy of the device position.
" } }, @@ -1491,6 +1681,7 @@ "BatchPutGeofenceRequestEntry$GeofenceProperties": "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: \"key\" : \"value\"
The properties associated with the position.
", "DevicePositionUpdate$PositionProperties": "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: \"key\" : \"value\"
The geofence properties.
", "GetDevicePositionResponse$PositionProperties": "The properties associated with the position.
", "GetGeofenceResponse$GeofenceProperties": "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: \"key\" : \"value\"
The properties associated with the position.
", @@ -1597,6 +1788,7 @@ "DescribeTrackerRequest$TrackerName": "The name of the tracker resource.
", "DescribeTrackerResponse$TrackerName": "The name of the tracker resource.
", "DisassociateTrackerConsumerRequest$TrackerName": "The name of the tracker resource to be dissociated from the consumer.
", + "ForecastGeofenceEventsRequest$CollectionName": "The name of the geofence collection.
", "GetDevicePositionHistoryRequest$TrackerName": "The tracker resource receiving the request for the device position history.
", "GetDevicePositionRequest$TrackerName": "The tracker resource receiving the position update.
", "GetGeofenceRequest$CollectionName": "The geofence collection storing the target geofence.
", @@ -1629,7 +1821,8 @@ "UpdateRouteCalculatorRequest$CalculatorName": "The name of the route calculator resource to update.
", "UpdateRouteCalculatorResponse$CalculatorName": "The name of the updated route calculator resource.
", "UpdateTrackerRequest$TrackerName": "The name of the tracker resource to update.
", - "UpdateTrackerResponse$TrackerName": "The name of the updated tracker resource.
" + "UpdateTrackerResponse$TrackerName": "The name of the updated tracker resource.
", + "VerifyDevicePositionRequest$TrackerName": "The name of the tracker resource to be associated with verification request.
" } }, "ResourceNotFoundException": { @@ -1679,6 +1872,20 @@ "RouteMatrix$member": null } }, + "Rsrp": { + "base": null, + "refs": { + "LteCellDetails$Rsrp": "Signal power of the reference signal received, measured in decibel-milliwatts (dBm).
", + "LteNetworkMeasurements$Rsrp": "Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
" + } + }, + "Rsrq": { + "base": null, + "refs": { + "LteCellDetails$Rsrq": "Signal quality of the reference Signal received, measured in decibels (dB).
", + "LteNetworkMeasurements$Rsrq": "Signal quality of the reference Signal received, measured in decibels (dB).
" + } + }, "SearchForPositionResult": { "base": "Contains a search result from a position search query that is run on a place index resource.
", "refs": { @@ -1811,6 +2018,13 @@ "refs": { } }, + "SpeedUnit": { + "base": null, + "refs": { + "ForecastGeofenceEventsRequest$SpeedUnit": "The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.
Default Value: KilometersPerHour.
The speed unit for the forecasted events.
" + } + }, "Status": { "base": null, "refs": { @@ -1865,15 +2079,15 @@ "DescribeRouteCalculatorResponse$DataSource": "The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
", "DescribeTrackerResponse$PricingPlanDataSource": "No longer used. Always returns an empty string.
", "GetGeofenceResponse$Status": "Identifies the state of the geofence. A geofence will hold one of the following states:
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.
A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.
Valid font stacks for Esri styles:
VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold | Arial Unicode MS Bold | Arial Unicode MS Regular
Valid font stacks for HERE Technologies styles:
VectorHereContrast – Fira GO Regular | Fira GO Bold
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular
Valid font stacks for GrabMaps styles:
VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto Sans Medium | Noto Sans Bold
Valid font stacks for Open Data styles:
VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.
The HTTP Cache-Control directive for the value.
", + "GetMapGlyphsRequest$FontStack": "A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.
Valid font stacks for Esri styles:
VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold
Valid font stacks for HERE Technologies styles:
VectorHereContrast – Fira GO Regular | Fira GO Bold
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular
Valid font stacks for GrabMaps styles:
VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto Sans Medium | Noto Sans Bold
Valid font stacks for Open Data styles:
VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold | Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold | Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.
The map glyph content type. For example, application/octet-stream.
The HTTP Cache-Control directive for the value.
", + "GetMapGlyphsResponse$CacheControl": "The HTTP Cache-Control directive for the value.
", "GetMapSpritesResponse$ContentType": "The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.
The HTTP Cache-Control directive for the value.
", + "GetMapSpritesResponse$CacheControl": "The HTTP Cache-Control directive for the value.
", "GetMapStyleDescriptorResponse$ContentType": "The style descriptor's content type. For example, application/json.
The HTTP Cache-Control directive for the value.
", + "GetMapStyleDescriptorResponse$CacheControl": "The HTTP Cache-Control directive for the value.
", "GetMapTileResponse$ContentType": "The map tile's content type. For example, application/vnd.mapbox-vector-tile.
The HTTP Cache-Control directive for the value.
", "InternalServerException$Message": null, "ListGeofenceCollectionsResponseEntry$PricingPlanDataSource": "No longer used. Always returns an empty string.
", "ListGeofenceResponseEntry$Status": "Identifies the state of the geofence. A geofence will hold one of the following states:
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.
The data provider of geospatial data. Values can be one of the following:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
", "ListRouteCalculatorsResponseEntry$DataSource": "The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
", "ListTrackersResponseEntry$PricingPlanDataSource": "No longer used. Always returns an empty string.
", - "Place$AddressNumber": "The numerical portion of an address, such as a building number.
", - "Place$Country": "A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.
A name for a local area, such as a city or town name. For example, Toronto.
The name of a community district. For example, Downtown.
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
", - "Place$Region": "A name for an area or geographical division, such as a province or state name. For example, British Columbia.
The numerical portion of an address, such as a building number.
", "Place$Street": "The name for a street or a road to identify a location. For example, Main Street.
An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.
This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district.
For more information about data providers, see Amazon Location Service data providers.
", + "Place$Neighborhood": "The name of a community district. For example, Downtown.
A name for a local area, such as a city or town name. For example, Toronto.
A county, or an area that's part of a larger region. For example, Metro Vancouver.
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.
This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for SearchPlaceIndexForPosition.
For addresses with a UnitNumber, the type of unit. For example, Apartment.
This property is returned only for a place index that uses Esri as a data provider.
A name for an area or geographical division, such as a province or state name. For example, British Columbia.
A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
", + "Place$UnitType": "For addresses with a UnitNumber, the type of unit. For example, Apartment.
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 3B or Unit 123.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.
An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.
A message about the error that occurred for the route calculation.
", "SearchForSuggestionsResult$Text": "The text of the place suggestion, typically formatted as an address string.
", @@ -1906,8 +2120,8 @@ "UpdateGeofenceCollectionRequest$PricingPlanDataSource": "This parameter is no longer used.
", "UpdateTrackerRequest$PricingPlanDataSource": "This parameter is no longer used.
", "ValidationException$Message": null, - "ValidationExceptionField$Message": "A message with the reason for the validation exception error.
", - "ValidationExceptionField$Name": "The field name where the invalid entry was detected.
" + "ValidationExceptionField$Name": "The field name where the invalid entry was detected.
", + "ValidationExceptionField$Message": "A message with the reason for the validation exception error.
" } }, "TagKey": { @@ -1976,8 +2190,8 @@ "BatchPutGeofenceSuccess$UpdateTime": "The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both 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.
Setting a departure time in the past returns a 400 ValidationException error.
In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
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 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: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
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 timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.
The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
For example, 2020–07-2T12:15:20.000Z+01:00
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.
Requirement:
The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.
Requirement:
The time specified for StartTimeInclusive must be before EndTimeExclusive.
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.
Requirement:
The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the API key resource will expire, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp of when the API key was last updated, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
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.
", "ListGeofenceCollectionsRequest$NextToken": "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: null
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.
", - "ListGeofencesRequest$NextToken": "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: null
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.
", "ListKeysRequest$NextToken": "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: null
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.
", "ListMapsRequest$NextToken": "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: null
The forecasted event identifier.
" + } + }, "ValidationException": { "base": "The input failed to meet the constraints specified by the AWS service.
", "refs": { @@ -2206,6 +2428,40 @@ "refs": { "TruckWeight$Unit": "The unit of measurement to use for the truck weight.
Default Value: Kilograms
Wi-Fi access point.
", + "refs": { + "WiFiAccessPointList$member": null + } + }, + "WiFiAccessPointList": { + "base": null, + "refs": { + "DeviceState$WiFiAccessPoints": "The Wi-Fi access points the device is using.
" + } + }, + "WiFiAccessPointMacAddressString": { + "base": null, + "refs": { + "WiFiAccessPoint$MacAddress": "Medium access control address (Mac).
" + } + }, + "WiFiAccessPointRssInteger": { + "base": null, + "refs": { + "WiFiAccessPoint$Rss": "Received signal strength (dBm) of the WLAN measurement data.
" + } } } } diff --git a/models/apis/location/2020-11-19/paginators-1.json b/models/apis/location/2020-11-19/paginators-1.json index 24ca27f63d8..8f919c6b676 100644 --- a/models/apis/location/2020-11-19/paginators-1.json +++ b/models/apis/location/2020-11-19/paginators-1.json @@ -1,5 +1,11 @@ { "pagination": { + "ForecastGeofenceEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ForecastedEvents" + }, "GetDevicePositionHistory": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/sns/2010-03-31/api-2.json b/models/apis/sns/2010-03-31/api-2.json index d4e2c8b882b..a199db705f0 100644 --- a/models/apis/sns/2010-03-31/api-2.json +++ b/models/apis/sns/2010-03-31/api-2.json @@ -4,12 +4,14 @@ "apiVersion":"2010-03-31", "endpointPrefix":"sns", "protocol":"query", + "protocols":["query"], "serviceAbbreviation":"Amazon SNS", "serviceFullName":"Amazon Simple Notification Service", "serviceId":"SNS", "signatureVersion":"v4", "uid":"sns-2010-03-31", - "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/" + "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddPermission":{ diff --git a/models/apis/sns/2010-03-31/docs-2.json b/models/apis/sns/2010-03-31/docs-2.json index 553f170341a..bab7bdfd892 100644 --- a/models/apis/sns/2010-03-31/docs-2.json +++ b/models/apis/sns/2010-03-31/docs-2.json @@ -5,7 +5,7 @@ "AddPermission": "Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".
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 PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.
PlatformPrincipal and PlatformCredential are received from the notification service.
For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
For GCM (Firebase Cloud Messaging) using token credentials, there is no 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`.
For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.
You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.
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 PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.
PlatformPrincipal and PlatformCredential are received from the notification service.
For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.
For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
For GCM (Firebase Cloud Messaging) using token credentials, there is no 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`.
For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.
You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
", "CreateTopic": "Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
", @@ -777,8 +777,8 @@ "SubscriptionAttributesMap": { "base": null, "refs": { - "GetSubscriptionAttributesResponse$Attributes": "A map of the subscription's attributes. Attributes in this map include 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.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
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 the 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.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
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:
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.
A map of the subscription's attributes. Attributes in this map include 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.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
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 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.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
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:
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.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the 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.
The following attribute applies only to server-side encryption:
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.
The following attributes apply only to FIFO topics:
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.
By default, 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.
When you set 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).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of attributes with their corresponding values.
The following lists names, descriptions, and values of the special request parameters that the 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.
The following attribute applies only to server-side encryption:
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.
The following attributes apply only to FIFO topics:
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.
By default, 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.
When you set 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).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner – The Amazon Web Services account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
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. The signature is a Base64-encoded SHA1withRSA signature.
When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
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.
The following attribute applies only to server-side-encryption:
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.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, 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.
When you set 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).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
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:
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.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
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:
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.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:
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 SetTopicAttributes action uses:
ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
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.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
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.
HTTP
HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
Amazon Kinesis Data Firehose
FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
Lambda
LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
Platform application endpoint
ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
Amazon SQS
SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.
The following attribute applies only to server-side-encryption:
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.
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.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, 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.
When you set 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).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
The subject of the batch message.
", - "PublishInput$Subject": "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.
" + "PublishInput$Subject": "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.
" } }, "subscriptionARN": { diff --git a/models/apis/sqs/2012-11-05/api-2.json b/models/apis/sqs/2012-11-05/api-2.json index 2ab3b11e8bc..7cfd478b990 100644 --- a/models/apis/sqs/2012-11-05/api-2.json +++ b/models/apis/sqs/2012-11-05/api-2.json @@ -7,6 +7,7 @@ "endpointPrefix":"sqs", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"Amazon SQS", "serviceFullName":"Amazon Simple Queue Service", "serviceId":"SQS", diff --git a/models/apis/sqs/2012-11-05/docs-2.json b/models/apis/sqs/2012-11-05/docs-2.json index 0361fa02ca5..26faf390706 100644 --- a/models/apis/sqs/2012-11-05/docs-2.json +++ b/models/apis/sqs/2012-11-05/docs-2.json @@ -19,8 +19,8 @@ "PurgeQueue": "Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter.
When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.
Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321.
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
You can use 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.
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 200.
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:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
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 DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
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.
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.
You can use 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.
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 200.
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.
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", "SendMessageBatchResultEntry$SequenceNumber": "This parameter applies only to FIFO (first-in-first-out) queues.
The large, non-consecutive number that Amazon SQS assigns to each message.
The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
", - "SendMessageRequest$MessageBody": "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:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
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.
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
The maximum length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", diff --git a/models/apis/storagegateway/2013-06-30/api-2.json b/models/apis/storagegateway/2013-06-30/api-2.json index ea4ba2aa49b..8b38d1f086a 100644 --- a/models/apis/storagegateway/2013-06-30/api-2.json +++ b/models/apis/storagegateway/2013-06-30/api-2.json @@ -5,11 +5,13 @@ "endpointPrefix":"storagegateway", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceFullName":"AWS Storage Gateway", "serviceId":"Storage Gateway", "signatureVersion":"v4", "targetPrefix":"StorageGateway_20130630", - "uid":"storagegateway-2013-06-30" + "uid":"storagegateway-2013-06-30", + "auth":["aws.auth#sigv4"] }, "operations":{ "ActivateGateway":{ @@ -1405,6 +1407,13 @@ "max":10, "min":1 }, + "AutomaticUpdatePolicy":{ + "type":"string", + "enum":[ + "ALL_VERSIONS", + "EMERGENCY_VERSIONS_ONLY" + ] + }, "AvailabilityMonitorTestStatus":{ "type":"string", "enum":[ @@ -2125,7 +2134,8 @@ "MinuteOfHour":{"shape":"MinuteOfHour"}, "DayOfWeek":{"shape":"DayOfWeek"}, "DayOfMonth":{"shape":"DayOfMonth"}, - "Timezone":{"shape":"GatewayTimezone"} + "Timezone":{"shape":"GatewayTimezone"}, + "SoftwareUpdatePreferences":{"shape":"SoftwareUpdatePreferences"} } }, "DescribeNFSFileSharesInput":{ @@ -3416,6 +3426,12 @@ "type":"string", "pattern":"\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z" }, + "SoftwareUpdatePreferences":{ + "type":"structure", + "members":{ + "AutomaticUpdatePolicy":{"shape":"AutomaticUpdatePolicy"} + } + }, "SoftwareUpdatesEndDate":{ "type":"string", "max":25, @@ -3772,17 +3788,14 @@ }, "UpdateMaintenanceStartTimeInput":{ "type":"structure", - "required":[ - "GatewayARN", - "HourOfDay", - "MinuteOfHour" - ], + "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "HourOfDay":{"shape":"HourOfDay"}, "MinuteOfHour":{"shape":"MinuteOfHour"}, "DayOfWeek":{"shape":"DayOfWeek"}, - "DayOfMonth":{"shape":"DayOfMonth"} + "DayOfMonth":{"shape":"DayOfMonth"}, + "SoftwareUpdatePreferences":{"shape":"SoftwareUpdatePreferences"} } }, "UpdateMaintenanceStartTimeOutput":{ diff --git a/models/apis/storagegateway/2013-06-30/docs-2.json b/models/apis/storagegateway/2013-06-30/docs-2.json index a5e64ee74c7..6f37621aa3a 100644 --- a/models/apis/storagegateway/2013-06-30/docs-2.json +++ b/models/apis/storagegateway/2013-06-30/docs-2.json @@ -39,7 +39,7 @@ "DescribeChapCredentials": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
", "DescribeFileSystemAssociations": "Gets the file system association information. This operation is only supported for FSx File Gateways.
", "DescribeGatewayInformation": "Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", - "DescribeMaintenanceStartTime": "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.
", + "DescribeMaintenanceStartTime": "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.
", "DescribeNFSFileShares": "Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
", "DescribeSMBFileShares": "Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
", "DescribeSMBSettings": "Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
", @@ -82,14 +82,14 @@ "UpdateBandwidthRateLimitSchedule": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.
", "UpdateChapCredentials": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Updates a file system association. This operation is only supported in the FSx File Gateways.
", - "UpdateGatewayInformation": "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 the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.
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.
", + "UpdateMaintenanceStartTime": "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 MinuteOfHour and HourOfDay, and either DayOfMonth or DayOfWeek.
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 a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share settings:
Default storage class for your S3 bucket
Metadata defaults for your S3 bucket
Allowed NFS clients for your file share
Squash settings
Write status of your file share
Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.
To leave a file share field unchanged, set the corresponding input field to null.
File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.
", "UpdateSMBLocalGroups": "Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
", - "UpdateSMBSecurityStrategy": "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.
Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
", "UpdateVTLDeviceType": "Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
" }, @@ -233,6 +233,12 @@ "UpdateAutomaticTapeCreationPolicyInput$AutomaticTapeCreationRules": "An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.
" } }, + "AutomaticUpdatePolicy": { + "base": null, + "refs": { + "SoftwareUpdatePreferences$AutomaticUpdatePolicy": "Indicates the automatic update policy for a gateway.
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
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.
", - "UpdateMaintenanceStartTimeInput$DayOfMonth": "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.
" + "DescribeMaintenanceStartTimeOutput$DayOfMonth": "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.
", + "UpdateMaintenanceStartTimeInput$DayOfMonth": "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.
" } }, "DayOfWeek": { @@ -535,7 +541,7 @@ "refs": { "DaysOfWeek$member": null, "DescribeMaintenanceStartTimeOutput$DayOfWeek": "An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
", - "UpdateMaintenanceStartTimeInput$DayOfWeek": "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.
" + "UpdateMaintenanceStartTimeInput$DayOfWeek": "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.
" } }, "DaysOfWeek": { @@ -737,7 +743,7 @@ } }, "DescribeMaintenanceStartTimeOutput": { - "base": "A JSON object containing the following fields:
A JSON object containing the following fields:
", "refs": { } }, @@ -1301,7 +1307,7 @@ "refs": { "DescribeGatewayInformationOutput$GatewayCapacity": "Specifies the size of the gateway's metadata cache.
", "SupportedGatewayCapacities$member": null, - "UpdateGatewayInformationInput$GatewayCapacity": "Specifies the size of the gateway's metadata cache.
" + "UpdateGatewayInformationInput$GatewayCapacity": "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.
" } }, "GatewayId": { @@ -1977,8 +1983,8 @@ "SMBSecurityStrategy": { "base": null, "refs": { - "DescribeSMBSettingsOutput$SMBSecurityStrategy": "The type of security strategy that was specified for file gateway.
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.
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.
" + "DescribeSMBSettingsOutput$SMBSecurityStrategy": "The type of security strategy that was specified for file gateway.
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.
Specifies the type of security strategy.
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.
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
" } }, + "SoftwareUpdatePreferences": { + "base": "A set of variables indicating the software update preferences for the gateway.
", + "refs": { + "DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences": "A set of variables indicating the software update preferences for the gateway.
Includes AutomaticUpdatePolicy field with the following inputs:
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
A set of variables indicating the software update preferences for the gateway.
Includes AutomaticUpdatePolicy field with the following inputs:
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
A JSON object containing the following fields:
A JSON object containing the following fields:
", "refs": { } }, diff --git a/service/account/accountiface/interface.go b/service/account/accountiface/interface.go index 2a2fe0dcd2f..4b360792397 100644 --- a/service/account/accountiface/interface.go +++ b/service/account/accountiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // AWS Account. // func myFunc(svc accountiface.AccountAPI) bool { -// // Make svc.DeleteAlternateContact request +// // Make svc.AcceptPrimaryEmailUpdate request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockAccountClient struct { // accountiface.AccountAPI // } -// func (m *mockAccountClient) DeleteAlternateContact(input *account.DeleteAlternateContactInput) (*account.DeleteAlternateContactOutput, error) { +// func (m *mockAccountClient) AcceptPrimaryEmailUpdate(input *account.AcceptPrimaryEmailUpdateInput) (*account.AcceptPrimaryEmailUpdateOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,10 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type AccountAPI interface { + AcceptPrimaryEmailUpdate(*account.AcceptPrimaryEmailUpdateInput) (*account.AcceptPrimaryEmailUpdateOutput, error) + AcceptPrimaryEmailUpdateWithContext(aws.Context, *account.AcceptPrimaryEmailUpdateInput, ...request.Option) (*account.AcceptPrimaryEmailUpdateOutput, error) + AcceptPrimaryEmailUpdateRequest(*account.AcceptPrimaryEmailUpdateInput) (*request.Request, *account.AcceptPrimaryEmailUpdateOutput) + DeleteAlternateContact(*account.DeleteAlternateContactInput) (*account.DeleteAlternateContactOutput, error) DeleteAlternateContactWithContext(aws.Context, *account.DeleteAlternateContactInput, ...request.Option) (*account.DeleteAlternateContactOutput, error) DeleteAlternateContactRequest(*account.DeleteAlternateContactInput) (*request.Request, *account.DeleteAlternateContactOutput) @@ -80,6 +84,10 @@ type AccountAPI interface { GetContactInformationWithContext(aws.Context, *account.GetContactInformationInput, ...request.Option) (*account.GetContactInformationOutput, error) GetContactInformationRequest(*account.GetContactInformationInput) (*request.Request, *account.GetContactInformationOutput) + GetPrimaryEmail(*account.GetPrimaryEmailInput) (*account.GetPrimaryEmailOutput, error) + GetPrimaryEmailWithContext(aws.Context, *account.GetPrimaryEmailInput, ...request.Option) (*account.GetPrimaryEmailOutput, error) + GetPrimaryEmailRequest(*account.GetPrimaryEmailInput) (*request.Request, *account.GetPrimaryEmailOutput) + GetRegionOptStatus(*account.GetRegionOptStatusInput) (*account.GetRegionOptStatusOutput, error) GetRegionOptStatusWithContext(aws.Context, *account.GetRegionOptStatusInput, ...request.Option) (*account.GetRegionOptStatusOutput, error) GetRegionOptStatusRequest(*account.GetRegionOptStatusInput) (*request.Request, *account.GetRegionOptStatusOutput) @@ -98,6 +106,10 @@ type AccountAPI interface { PutContactInformation(*account.PutContactInformationInput) (*account.PutContactInformationOutput, error) PutContactInformationWithContext(aws.Context, *account.PutContactInformationInput, ...request.Option) (*account.PutContactInformationOutput, error) PutContactInformationRequest(*account.PutContactInformationInput) (*request.Request, *account.PutContactInformationOutput) + + StartPrimaryEmailUpdate(*account.StartPrimaryEmailUpdateInput) (*account.StartPrimaryEmailUpdateOutput, error) + StartPrimaryEmailUpdateWithContext(aws.Context, *account.StartPrimaryEmailUpdateInput, ...request.Option) (*account.StartPrimaryEmailUpdateOutput, error) + StartPrimaryEmailUpdateRequest(*account.StartPrimaryEmailUpdateInput) (*request.Request, *account.StartPrimaryEmailUpdateOutput) } var _ AccountAPI = (*account.Account)(nil) diff --git a/service/account/api.go b/service/account/api.go index 0b83d445e45..71350224c69 100644 --- a/service/account/api.go +++ b/service/account/api.go @@ -12,6 +12,107 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/restjson" ) +const opAcceptPrimaryEmailUpdate = "AcceptPrimaryEmailUpdate" + +// AcceptPrimaryEmailUpdateRequest generates a "aws/request.Request" representing the +// client's request for the AcceptPrimaryEmailUpdate operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See AcceptPrimaryEmailUpdate for more information on using the AcceptPrimaryEmailUpdate +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the AcceptPrimaryEmailUpdateRequest method. +// req, resp := client.AcceptPrimaryEmailUpdateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/AcceptPrimaryEmailUpdate +func (c *Account) AcceptPrimaryEmailUpdateRequest(input *AcceptPrimaryEmailUpdateInput) (req *request.Request, output *AcceptPrimaryEmailUpdateOutput) { + op := &request.Operation{ + Name: opAcceptPrimaryEmailUpdate, + HTTPMethod: "POST", + HTTPPath: "/acceptPrimaryEmailUpdate", + } + + if input == nil { + input = &AcceptPrimaryEmailUpdateInput{} + } + + output = &AcceptPrimaryEmailUpdateOutput{} + req = c.newRequest(op, input, output) + return +} + +// AcceptPrimaryEmailUpdate API operation for AWS Account. +// +// 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. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Account's +// API operation AcceptPrimaryEmailUpdate for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The operation failed because it specified a resource that can't be found. +// +// - ValidationException +// The operation failed because one of the input parameters was invalid. +// +// - ConflictException +// The request could not be processed because of a conflict in the current status +// of the resource. For example, this happens if you try to enable a Region +// that is currently being disabled (in a status of DISABLING). +// +// - AccessDeniedException +// The operation failed because the calling identity doesn't have the minimum +// required permissions. +// +// - TooManyRequestsException +// The operation failed because it was called too frequently and exceeded a +// throttle limit. +// +// - InternalServerException +// The operation failed because of an error internal to Amazon Web Services. +// Try your operation again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/AcceptPrimaryEmailUpdate +func (c *Account) AcceptPrimaryEmailUpdate(input *AcceptPrimaryEmailUpdateInput) (*AcceptPrimaryEmailUpdateOutput, error) { + req, out := c.AcceptPrimaryEmailUpdateRequest(input) + return out, req.Send() +} + +// AcceptPrimaryEmailUpdateWithContext is the same as AcceptPrimaryEmailUpdate with the addition of +// the ability to pass a context and additional request options. +// +// See AcceptPrimaryEmailUpdate for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Account) AcceptPrimaryEmailUpdateWithContext(ctx aws.Context, input *AcceptPrimaryEmailUpdateInput, opts ...request.Option) (*AcceptPrimaryEmailUpdateOutput, error) { + req, out := c.AcceptPrimaryEmailUpdateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteAlternateContact = "DeleteAlternateContact" // DeleteAlternateContactRequest generates a "aws/request.Request" representing the @@ -162,6 +263,9 @@ func (c *Account) DisableRegionRequest(input *DisableRegionInput) (req *request. // // 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. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -511,6 +615,100 @@ func (c *Account) GetContactInformationWithContext(ctx aws.Context, input *GetCo return out, req.Send() } +const opGetPrimaryEmail = "GetPrimaryEmail" + +// GetPrimaryEmailRequest generates a "aws/request.Request" representing the +// client's request for the GetPrimaryEmail operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetPrimaryEmail for more information on using the GetPrimaryEmail +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetPrimaryEmailRequest method. +// req, resp := client.GetPrimaryEmailRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetPrimaryEmail +func (c *Account) GetPrimaryEmailRequest(input *GetPrimaryEmailInput) (req *request.Request, output *GetPrimaryEmailOutput) { + op := &request.Operation{ + Name: opGetPrimaryEmail, + HTTPMethod: "POST", + HTTPPath: "/getPrimaryEmail", + } + + if input == nil { + input = &GetPrimaryEmailInput{} + } + + output = &GetPrimaryEmailOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetPrimaryEmail API operation for AWS Account. +// +// Retrieves the primary email address for the specified account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Account's +// API operation GetPrimaryEmail for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The operation failed because it specified a resource that can't be found. +// +// - ValidationException +// The operation failed because one of the input parameters was invalid. +// +// - AccessDeniedException +// The operation failed because the calling identity doesn't have the minimum +// required permissions. +// +// - TooManyRequestsException +// The operation failed because it was called too frequently and exceeded a +// throttle limit. +// +// - InternalServerException +// The operation failed because of an error internal to Amazon Web Services. +// Try your operation again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetPrimaryEmail +func (c *Account) GetPrimaryEmail(input *GetPrimaryEmailInput) (*GetPrimaryEmailOutput, error) { + req, out := c.GetPrimaryEmailRequest(input) + return out, req.Send() +} + +// GetPrimaryEmailWithContext is the same as GetPrimaryEmail with the addition of +// the ability to pass a context and additional request options. +// +// See GetPrimaryEmail for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Account) GetPrimaryEmailWithContext(ctx aws.Context, input *GetPrimaryEmailInput, opts ...request.Option) (*GetPrimaryEmailOutput, error) { + req, out := c.GetPrimaryEmailRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetRegionOptStatus = "GetRegionOptStatus" // GetRegionOptStatusRequest generates a "aws/request.Request" representing the @@ -948,6 +1146,238 @@ func (c *Account) PutContactInformationWithContext(ctx aws.Context, input *PutCo return out, req.Send() } +const opStartPrimaryEmailUpdate = "StartPrimaryEmailUpdate" + +// StartPrimaryEmailUpdateRequest generates a "aws/request.Request" representing the +// client's request for the StartPrimaryEmailUpdate operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartPrimaryEmailUpdate for more information on using the StartPrimaryEmailUpdate +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the StartPrimaryEmailUpdateRequest method. +// req, resp := client.StartPrimaryEmailUpdateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/StartPrimaryEmailUpdate +func (c *Account) StartPrimaryEmailUpdateRequest(input *StartPrimaryEmailUpdateInput) (req *request.Request, output *StartPrimaryEmailUpdateOutput) { + op := &request.Operation{ + Name: opStartPrimaryEmailUpdate, + HTTPMethod: "POST", + HTTPPath: "/startPrimaryEmailUpdate", + } + + if input == nil { + input = &StartPrimaryEmailUpdateInput{} + } + + output = &StartPrimaryEmailUpdateOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartPrimaryEmailUpdate API operation for AWS Account. +// +// Starts the process to update the primary email address for the specified +// account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Account's +// API operation StartPrimaryEmailUpdate for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The operation failed because it specified a resource that can't be found. +// +// - ValidationException +// The operation failed because one of the input parameters was invalid. +// +// - ConflictException +// The request could not be processed because of a conflict in the current status +// of the resource. For example, this happens if you try to enable a Region +// that is currently being disabled (in a status of DISABLING). +// +// - AccessDeniedException +// The operation failed because the calling identity doesn't have the minimum +// required permissions. +// +// - TooManyRequestsException +// The operation failed because it was called too frequently and exceeded a +// throttle limit. +// +// - InternalServerException +// The operation failed because of an error internal to Amazon Web Services. +// Try your operation again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/StartPrimaryEmailUpdate +func (c *Account) StartPrimaryEmailUpdate(input *StartPrimaryEmailUpdateInput) (*StartPrimaryEmailUpdateOutput, error) { + req, out := c.StartPrimaryEmailUpdateRequest(input) + return out, req.Send() +} + +// StartPrimaryEmailUpdateWithContext is the same as StartPrimaryEmailUpdate with the addition of +// the ability to pass a context and additional request options. +// +// See StartPrimaryEmailUpdate for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Account) StartPrimaryEmailUpdateWithContext(ctx aws.Context, input *StartPrimaryEmailUpdateInput, opts ...request.Option) (*StartPrimaryEmailUpdateOutput, error) { + req, out := c.StartPrimaryEmailUpdateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +type AcceptPrimaryEmailUpdateInput struct { + _ struct{} `type:"structure"` + + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin + // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // 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 AccountId. + // + // AccountId is a required field + AccountId *string `type:"string" required:"true"` + + // The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate + // API call. + // + // Otp is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AcceptPrimaryEmailUpdateInput's + // String and GoString methods. + // + // Otp is a required field + Otp *string `type:"string" required:"true" sensitive:"true"` + + // The new primary email address for use with the specified account. This must + // match the PrimaryEmail from the StartPrimaryEmailUpdate API call. + // + // PrimaryEmail is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AcceptPrimaryEmailUpdateInput's + // String and GoString methods. + // + // PrimaryEmail is a required field + PrimaryEmail *string `min:"5" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AcceptPrimaryEmailUpdateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AcceptPrimaryEmailUpdateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AcceptPrimaryEmailUpdateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AcceptPrimaryEmailUpdateInput"} + if s.AccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AccountId")) + } + if s.Otp == nil { + invalidParams.Add(request.NewErrParamRequired("Otp")) + } + if s.PrimaryEmail == nil { + invalidParams.Add(request.NewErrParamRequired("PrimaryEmail")) + } + if s.PrimaryEmail != nil && len(*s.PrimaryEmail) < 5 { + invalidParams.Add(request.NewErrParamMinLen("PrimaryEmail", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountId sets the AccountId field's value. +func (s *AcceptPrimaryEmailUpdateInput) SetAccountId(v string) *AcceptPrimaryEmailUpdateInput { + s.AccountId = &v + return s +} + +// SetOtp sets the Otp field's value. +func (s *AcceptPrimaryEmailUpdateInput) SetOtp(v string) *AcceptPrimaryEmailUpdateInput { + s.Otp = &v + return s +} + +// SetPrimaryEmail sets the PrimaryEmail field's value. +func (s *AcceptPrimaryEmailUpdateInput) SetPrimaryEmail(v string) *AcceptPrimaryEmailUpdateInput { + s.PrimaryEmail = &v + return s +} + +type AcceptPrimaryEmailUpdateOutput struct { + _ struct{} `type:"structure"` + + // Retrieves the status of the accepted primary email update request. + Status *string `type:"string" enum:"PrimaryEmailUpdateStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AcceptPrimaryEmailUpdateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AcceptPrimaryEmailUpdateOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *AcceptPrimaryEmailUpdateOutput) SetStatus(v string) *AcceptPrimaryEmailUpdateOutput { + s.Status = &v + return s +} + // The operation failed because the calling identity doesn't have the minimum // required permissions. type AccessDeniedException struct { @@ -1253,8 +1683,11 @@ type ContactInformation struct { // PostalCode is a required field PostalCode *string `min:"1" type:"string" required:"true" sensitive:"true"` - // 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, 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. // // StateOrRegion is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's @@ -1530,9 +1963,9 @@ type DisableRegionInput struct { // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) @@ -1633,9 +2066,9 @@ type EnableRegionInput struct { // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) @@ -1844,9 +2277,9 @@ type GetContactInformationInput struct { // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) @@ -1917,6 +2350,101 @@ func (s *GetContactInformationOutput) SetContactInformation(v *ContactInformatio return s } +type GetPrimaryEmailInput struct { + _ struct{} `type:"structure"` + + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin + // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // 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 AccountId. + // + // AccountId is a required field + AccountId *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPrimaryEmailInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPrimaryEmailInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetPrimaryEmailInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetPrimaryEmailInput"} + if s.AccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AccountId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountId sets the AccountId field's value. +func (s *GetPrimaryEmailInput) SetAccountId(v string) *GetPrimaryEmailInput { + s.AccountId = &v + return s +} + +type GetPrimaryEmailOutput struct { + _ struct{} `type:"structure"` + + // Retrieves the primary email address associated with the specified account. + // + // PrimaryEmail is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetPrimaryEmailOutput's + // String and GoString methods. + PrimaryEmail *string `min:"5" type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPrimaryEmailOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPrimaryEmailOutput) GoString() string { + return s.String() +} + +// SetPrimaryEmail sets the PrimaryEmail field's value. +func (s *GetPrimaryEmailOutput) SetPrimaryEmail(v string) *GetPrimaryEmailOutput { + s.PrimaryEmail = &v + return s +} + type GetRegionOptStatusInput struct { _ struct{} `type:"structure"` @@ -1925,9 +2453,9 @@ type GetRegionOptStatusInput struct { // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) @@ -2109,9 +2637,9 @@ type ListRegionsInput struct { // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) @@ -2435,9 +2963,9 @@ type PutContactInformationInput struct { // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) @@ -2635,6 +3163,119 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +type StartPrimaryEmailUpdateInput struct { + _ struct{} `type:"structure"` + + // 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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), + // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin + // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // 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 AccountId. + // + // AccountId is a required field + AccountId *string `type:"string" required:"true"` + + // The new primary email address (also known as the root user email address) + // to use in the specified account. + // + // PrimaryEmail is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StartPrimaryEmailUpdateInput's + // String and GoString methods. + // + // PrimaryEmail is a required field + PrimaryEmail *string `min:"5" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPrimaryEmailUpdateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPrimaryEmailUpdateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartPrimaryEmailUpdateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartPrimaryEmailUpdateInput"} + if s.AccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AccountId")) + } + if s.PrimaryEmail == nil { + invalidParams.Add(request.NewErrParamRequired("PrimaryEmail")) + } + if s.PrimaryEmail != nil && len(*s.PrimaryEmail) < 5 { + invalidParams.Add(request.NewErrParamMinLen("PrimaryEmail", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountId sets the AccountId field's value. +func (s *StartPrimaryEmailUpdateInput) SetAccountId(v string) *StartPrimaryEmailUpdateInput { + s.AccountId = &v + return s +} + +// SetPrimaryEmail sets the PrimaryEmail field's value. +func (s *StartPrimaryEmailUpdateInput) SetPrimaryEmail(v string) *StartPrimaryEmailUpdateInput { + s.PrimaryEmail = &v + return s +} + +type StartPrimaryEmailUpdateOutput struct { + _ struct{} `type:"structure"` + + // The status of the primary email update request. + Status *string `type:"string" enum:"PrimaryEmailUpdateStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPrimaryEmailUpdateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPrimaryEmailUpdateOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *StartPrimaryEmailUpdateOutput) SetStatus(v string) *StartPrimaryEmailUpdateOutput { + s.Status = &v + return s +} + // The operation failed because it was called too frequently and exceeded a // throttle limit. type TooManyRequestsException struct { @@ -2845,6 +3486,22 @@ func AlternateContactType_Values() []string { } } +const ( + // PrimaryEmailUpdateStatusPending is a PrimaryEmailUpdateStatus enum value + PrimaryEmailUpdateStatusPending = "PENDING" + + // PrimaryEmailUpdateStatusAccepted is a PrimaryEmailUpdateStatus enum value + PrimaryEmailUpdateStatusAccepted = "ACCEPTED" +) + +// PrimaryEmailUpdateStatus_Values returns all elements of the PrimaryEmailUpdateStatus enum +func PrimaryEmailUpdateStatus_Values() []string { + return []string{ + PrimaryEmailUpdateStatusPending, + PrimaryEmailUpdateStatusAccepted, + } +} + const ( // RegionOptStatusEnabled is a RegionOptStatus enum value RegionOptStatusEnabled = "ENABLED" diff --git a/service/firehose/api.go b/service/firehose/api.go index f5ac526bc8a..a7ba464afbf 100644 --- a/service/firehose/api.go +++ b/service/firehose/api.go @@ -904,9 +904,9 @@ func (c *Firehose) StartDeliveryStreamEncryptionRequest(input *StartDeliveryStre // creates a grant that enables it to use the new CMK to encrypt and decrypt // data and to manage the grant. // -// For the KMS grant creation to be successful, Firehose APIs StartDeliveryStreamEncryption -// and CreateDeliveryStream should not be called with session credentials that -// are more than 6 hours old. +// For the KMS grant creation to be successful, the Firehose API operations +// StartDeliveryStreamEncryption and CreateDeliveryStream should not be called +// with session credentials that are more than 6 hours old. // // 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 @@ -5875,8 +5875,8 @@ type HttpEndpointDestinationConfiguration struct { // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` - // 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. RequestConfiguration *HttpEndpointRequestConfiguration `type:"structure"` // Describes the retry behavior in case Firehose is unable to deliver data to @@ -5898,6 +5898,9 @@ type HttpEndpointDestinationConfiguration struct { // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` + + // The configuration that defines how you access secrets for HTTP Endpoint destination. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` } // String returns the string representation. @@ -5955,6 +5958,11 @@ func (s *HttpEndpointDestinationConfiguration) Validate() error { invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6016,6 +6024,12 @@ func (s *HttpEndpointDestinationConfiguration) SetS3Configuration(v *S3Destinati return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *HttpEndpointDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationConfiguration { + s.SecretsManagerConfiguration = v + return s +} + // Describes the HTTP endpoint destination. type HttpEndpointDestinationDescription struct { _ struct{} `type:"structure"` @@ -6056,6 +6070,9 @@ type HttpEndpointDestinationDescription struct { // Describes a destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` + + // The configuration that defines how you access secrets for HTTP Endpoint destination. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` } // String returns the string representation. @@ -6130,6 +6147,12 @@ func (s *HttpEndpointDestinationDescription) SetS3DestinationDescription(v *S3De return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *HttpEndpointDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationDescription { + s.SecretsManagerConfiguration = v + return s +} + // Updates the specified HTTP endpoint destination. type HttpEndpointDestinationUpdate struct { _ struct{} `type:"structure"` @@ -6171,6 +6194,9 @@ type HttpEndpointDestinationUpdate struct { // Describes an update for a destination in Amazon S3. S3Update *S3DestinationUpdate `type:"structure"` + + // The configuration that defines how you access secrets for HTTP Endpoint destination. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` } // String returns the string representation. @@ -6222,6 +6248,11 @@ func (s *HttpEndpointDestinationUpdate) Validate() error { invalidParams.AddNested("S3Update", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6283,6 +6314,12 @@ func (s *HttpEndpointDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *Htt return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *HttpEndpointDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationUpdate { + s.SecretsManagerConfiguration = v + return s +} + // The configuration of the HTTP endpoint request. type HttpEndpointRequestConfiguration struct { _ struct{} `type:"structure"` @@ -7527,7 +7564,7 @@ func (s *OutputFormatConfiguration) SetSerializer(v *Serializer) *OutputFormatCo } // A serializer to use for converting data to the Parquet format before storing -// it in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/documentation/latest/). +// it in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/docs/). type ParquetSerDe struct { _ struct{} `type:"structure"` @@ -8194,9 +8231,7 @@ type RedshiftDestinationConfiguration struct { // Password is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationConfiguration's // String and GoString methods. - // - // Password is a required field - Password *string `min:"6" type:"string" required:"true" sensitive:"true"` + Password *string `min:"6" type:"string" sensitive:"true"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` @@ -8230,14 +8265,15 @@ type RedshiftDestinationConfiguration struct { // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` + // The configuration that defines how you access secrets for Amazon Redshift. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` + // The name of the user. // // Username is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationConfiguration's // String and GoString methods. - // - // Username is a required field - Username *string `min:"1" type:"string" required:"true" sensitive:"true"` + Username *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -8270,9 +8306,6 @@ func (s *RedshiftDestinationConfiguration) Validate() error { if s.CopyCommand == nil { invalidParams.Add(request.NewErrParamRequired("CopyCommand")) } - if s.Password == nil { - invalidParams.Add(request.NewErrParamRequired("Password")) - } if s.Password != nil && len(*s.Password) < 6 { invalidParams.Add(request.NewErrParamMinLen("Password", 6)) } @@ -8285,9 +8318,6 @@ func (s *RedshiftDestinationConfiguration) Validate() error { if s.S3Configuration == nil { invalidParams.Add(request.NewErrParamRequired("S3Configuration")) } - if s.Username == nil { - invalidParams.Add(request.NewErrParamRequired("Username")) - } if s.Username != nil && len(*s.Username) < 1 { invalidParams.Add(request.NewErrParamMinLen("Username", 1)) } @@ -8311,6 +8341,11 @@ func (s *RedshiftDestinationConfiguration) Validate() error { invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8378,6 +8413,12 @@ func (s *RedshiftDestinationConfiguration) SetS3Configuration(v *S3DestinationCo return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *RedshiftDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *RedshiftDestinationConfiguration { + s.SecretsManagerConfiguration = v + return s +} + // SetUsername sets the Username field's value. func (s *RedshiftDestinationConfiguration) SetUsername(v string) *RedshiftDestinationConfiguration { s.Username = &v @@ -8426,14 +8467,15 @@ type RedshiftDestinationDescription struct { // S3DestinationDescription is a required field S3DestinationDescription *S3DestinationDescription `type:"structure" required:"true"` + // The configuration that defines how you access secrets for Amazon Redshift. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` + // The name of the user. // // Username is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationDescription's // String and GoString methods. - // - // Username is a required field - Username *string `min:"1" type:"string" required:"true" sensitive:"true"` + Username *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -8508,6 +8550,12 @@ func (s *RedshiftDestinationDescription) SetS3DestinationDescription(v *S3Destin return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *RedshiftDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *RedshiftDestinationDescription { + s.SecretsManagerConfiguration = v + return s +} + // SetUsername sets the Username field's value. func (s *RedshiftDestinationDescription) SetUsername(v string) *RedshiftDestinationDescription { s.Username = &v @@ -8560,6 +8608,9 @@ type RedshiftDestinationUpdate struct { // doesn't support these compression formats. S3Update *S3DestinationUpdate `type:"structure"` + // The configuration that defines how you access secrets for Amazon Redshift. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` + // The name of the user. // // Username is a sensitive parameter and its value will be @@ -8621,6 +8672,11 @@ func (s *RedshiftDestinationUpdate) Validate() error { invalidParams.AddNested("S3Update", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8688,6 +8744,12 @@ func (s *RedshiftDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *Redshif return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *RedshiftDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *RedshiftDestinationUpdate { + s.SecretsManagerConfiguration = v + return s +} + // SetUsername sets the Username field's value. func (s *RedshiftDestinationUpdate) SetUsername(v string) *RedshiftDestinationUpdate { s.Username = &v @@ -9418,6 +9480,88 @@ func (s *SchemaConfiguration) SetVersionId(v string) *SchemaConfiguration { return s } +// The structure that defines how Firehose accesses the secret. +type SecretsManagerConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies whether you want to use the the secrets manager feature. When set + // as 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. + // + // Enabled is a required field + Enabled *bool `type:"boolean" required:"true"` + + // 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. + RoleARN *string `min:"1" type:"string"` + + // 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 True. + SecretARN *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecretsManagerConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecretsManagerConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SecretsManagerConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SecretsManagerConfiguration"} + if s.Enabled == nil { + invalidParams.Add(request.NewErrParamRequired("Enabled")) + } + if s.RoleARN != nil && len(*s.RoleARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RoleARN", 1)) + } + if s.SecretARN != nil && len(*s.SecretARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecretARN", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnabled sets the Enabled field's value. +func (s *SecretsManagerConfiguration) SetEnabled(v bool) *SecretsManagerConfiguration { + s.Enabled = &v + return s +} + +// SetRoleARN sets the RoleARN field's value. +func (s *SecretsManagerConfiguration) SetRoleARN(v string) *SecretsManagerConfiguration { + s.RoleARN = &v + return s +} + +// SetSecretARN sets the SecretARN field's value. +func (s *SecretsManagerConfiguration) SetSecretARN(v string) *SecretsManagerConfiguration { + s.SecretARN = &v + return s +} + // The serializer that you want Firehose to use to convert data to the target // format before writing it to Amazon S3. Firehose supports two types of serializers: // the ORC SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html) @@ -9612,9 +9756,7 @@ type SnowflakeDestinationConfiguration struct { // PrivateKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. - // - // PrivateKey is a required field - PrivateKey *string `min:"256" type:"string" required:"true" sensitive:"true"` + PrivateKey *string `min:"256" type:"string" sensitive:"true"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` @@ -9646,6 +9788,9 @@ type SnowflakeDestinationConfiguration struct { // Schema is a required field Schema *string `min:"1" type:"string" required:"true" sensitive:"true"` + // The configuration that defines how you access secrets for Snowflake. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` + // Optionally configure a Snowflake role. Otherwise the default user role will // be used. SnowflakeRoleConfiguration *SnowflakeRoleConfiguration `type:"structure"` @@ -9670,9 +9815,7 @@ type SnowflakeDestinationConfiguration struct { // User is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. - // - // User is a required field - User *string `min:"1" type:"string" required:"true" sensitive:"true"` + User *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -9717,9 +9860,6 @@ func (s *SnowflakeDestinationConfiguration) Validate() error { if s.MetaDataColumnName != nil && len(*s.MetaDataColumnName) < 1 { invalidParams.Add(request.NewErrParamMinLen("MetaDataColumnName", 1)) } - if s.PrivateKey == nil { - invalidParams.Add(request.NewErrParamRequired("PrivateKey")) - } if s.PrivateKey != nil && len(*s.PrivateKey) < 256 { invalidParams.Add(request.NewErrParamMinLen("PrivateKey", 256)) } @@ -9744,9 +9884,6 @@ func (s *SnowflakeDestinationConfiguration) Validate() error { if s.Table != nil && len(*s.Table) < 1 { invalidParams.Add(request.NewErrParamMinLen("Table", 1)) } - if s.User == nil { - invalidParams.Add(request.NewErrParamRequired("User")) - } if s.User != nil && len(*s.User) < 1 { invalidParams.Add(request.NewErrParamMinLen("User", 1)) } @@ -9760,6 +9897,11 @@ func (s *SnowflakeDestinationConfiguration) Validate() error { invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if s.SnowflakeRoleConfiguration != nil { if err := s.SnowflakeRoleConfiguration.Validate(); err != nil { invalidParams.AddNested("SnowflakeRoleConfiguration", err.(request.ErrInvalidParams)) @@ -9861,6 +10003,12 @@ func (s *SnowflakeDestinationConfiguration) SetSchema(v string) *SnowflakeDestin return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *SnowflakeDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SnowflakeDestinationConfiguration { + s.SecretsManagerConfiguration = v + return s +} + // SetSnowflakeRoleConfiguration sets the SnowflakeRoleConfiguration field's value. func (s *SnowflakeDestinationConfiguration) SetSnowflakeRoleConfiguration(v *SnowflakeRoleConfiguration) *SnowflakeDestinationConfiguration { s.SnowflakeRoleConfiguration = v @@ -9951,6 +10099,9 @@ type SnowflakeDestinationDescription struct { // String and GoString methods. Schema *string `min:"1" type:"string" sensitive:"true"` + // The configuration that defines how you access secrets for Snowflake. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` + // Optionally configure a Snowflake role. Otherwise the default user role will // be used. SnowflakeRoleConfiguration *SnowflakeRoleConfiguration `type:"structure"` @@ -10066,6 +10217,12 @@ func (s *SnowflakeDestinationDescription) SetSchema(v string) *SnowflakeDestinat return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *SnowflakeDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SnowflakeDestinationDescription { + s.SecretsManagerConfiguration = v + return s +} + // SetSnowflakeRoleConfiguration sets the SnowflakeRoleConfiguration field's value. func (s *SnowflakeDestinationDescription) SetSnowflakeRoleConfiguration(v *SnowflakeRoleConfiguration) *SnowflakeDestinationDescription { s.SnowflakeRoleConfiguration = v @@ -10185,6 +10342,9 @@ type SnowflakeDestinationUpdate struct { // String and GoString methods. Schema *string `min:"1" type:"string" sensitive:"true"` + // Describes the Secrets Manager configuration in Snowflake. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` + // Optionally configure a Snowflake role. Otherwise the default user role will // be used. SnowflakeRoleConfiguration *SnowflakeRoleConfiguration `type:"structure"` @@ -10266,6 +10426,11 @@ func (s *SnowflakeDestinationUpdate) Validate() error { invalidParams.AddNested("S3Update", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if s.SnowflakeRoleConfiguration != nil { if err := s.SnowflakeRoleConfiguration.Validate(); err != nil { invalidParams.AddNested("SnowflakeRoleConfiguration", err.(request.ErrInvalidParams)) @@ -10362,6 +10527,12 @@ func (s *SnowflakeDestinationUpdate) SetSchema(v string) *SnowflakeDestinationUp return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *SnowflakeDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SnowflakeDestinationUpdate { + s.SecretsManagerConfiguration = v + return s +} + // SetSnowflakeRoleConfiguration sets the SnowflakeRoleConfiguration field's value. func (s *SnowflakeDestinationUpdate) SetSnowflakeRoleConfiguration(v *SnowflakeRoleConfiguration) *SnowflakeDestinationUpdate { s.SnowflakeRoleConfiguration = v @@ -10671,9 +10842,7 @@ type SplunkDestinationConfiguration struct { // This is a GUID that you obtain from your Splunk cluster when you create a // new HEC endpoint. - // - // HECToken is a required field - HECToken *string `type:"string" required:"true"` + HECToken *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` @@ -10696,6 +10865,9 @@ type SplunkDestinationConfiguration struct { // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` + + // The configuration that defines how you access secrets for Splunk. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` } // String returns the string representation. @@ -10728,9 +10900,6 @@ func (s *SplunkDestinationConfiguration) Validate() error { if s.HECEndpointType == nil { invalidParams.Add(request.NewErrParamRequired("HECEndpointType")) } - if s.HECToken == nil { - invalidParams.Add(request.NewErrParamRequired("HECToken")) - } if s.S3Configuration == nil { invalidParams.Add(request.NewErrParamRequired("S3Configuration")) } @@ -10749,6 +10918,11 @@ func (s *SplunkDestinationConfiguration) Validate() error { invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10816,6 +10990,12 @@ func (s *SplunkDestinationConfiguration) SetS3Configuration(v *S3DestinationConf return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *SplunkDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SplunkDestinationConfiguration { + s.SecretsManagerConfiguration = v + return s +} + // Describes a destination in Splunk. type SplunkDestinationDescription struct { _ struct{} `type:"structure"` @@ -10858,6 +11038,9 @@ type SplunkDestinationDescription struct { // The Amazon S3 destination.> S3DestinationDescription *S3DestinationDescription `type:"structure"` + + // The configuration that defines how you access secrets for Splunk. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` } // String returns the string representation. @@ -10938,6 +11121,12 @@ func (s *SplunkDestinationDescription) SetS3DestinationDescription(v *S3Destinat return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *SplunkDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SplunkDestinationDescription { + s.SecretsManagerConfiguration = v + return s +} + // Describes an update for a destination in Splunk. type SplunkDestinationUpdate struct { _ struct{} `type:"structure"` @@ -10984,6 +11173,9 @@ type SplunkDestinationUpdate struct { // Your update to the configuration of the backup Amazon S3 location. S3Update *S3DestinationUpdate `type:"structure"` + + // The configuration that defines how you access secrets for Splunk. + SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` } // String returns the string representation. @@ -11025,6 +11217,11 @@ func (s *SplunkDestinationUpdate) Validate() error { invalidParams.AddNested("S3Update", err.(request.ErrInvalidParams)) } } + if s.SecretsManagerConfiguration != nil { + if err := s.SecretsManagerConfiguration.Validate(); err != nil { + invalidParams.AddNested("SecretsManagerConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -11092,6 +11289,12 @@ func (s *SplunkDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *SplunkDes return s } +// SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value. +func (s *SplunkDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SplunkDestinationUpdate { + s.SecretsManagerConfiguration = v + return s +} + // Configures retry behavior in case Firehose is unable to deliver documents // to Splunk, or if it doesn't receive an acknowledgment from Splunk. type SplunkRetryOptions struct { @@ -11583,7 +11786,7 @@ type UpdateDestinationInput struct { // Deprecated: S3DestinationUpdate has been deprecated S3DestinationUpdate *S3DestinationUpdate `deprecated:"true" type:"structure"` - // Update to the Snowflake destination condiguration settings + // Update to the Snowflake destination configuration settings. SnowflakeDestinationUpdate *SnowflakeDestinationUpdate `type:"structure"` // Describes an update for a destination in Splunk. diff --git a/service/firehose/doc.go b/service/firehose/doc.go index 14e7f60c74e..a1fbe94ac99 100644 --- a/service/firehose/doc.go +++ b/service/firehose/doc.go @@ -7,7 +7,8 @@ // // 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. +// OpenSearch Service, Amazon Redshift, Splunk, and various other supported +// destinations. // // See https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04 for more information on this service. // diff --git a/service/fsx/api.go b/service/fsx/api.go index ac0622569c2..ebf0c81d1e5 100644 --- a/service/fsx/api.go +++ b/service/fsx/api.go @@ -2018,7 +2018,7 @@ func (c *FSx) DeleteFileSystemRequest(input *DeleteFileSystemInput) (req *reques // // 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 FileSystemId value to the DeleFileSystem operation. +// a FileSystemId value to the DeleteFileSystem operation. // // 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 @@ -2026,13 +2026,13 @@ func (c *FSx) DeleteFileSystemRequest(input *DeleteFileSystemInput) (req *reques // // To delete an Amazon FSx for Lustre file system, first unmount (https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html) // it from every connected Amazon EC2 instance, then provide a 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 -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics) +// 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 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics) // metric to be zero (if using automatic export) or you can run an export data // repository task (https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repo-task-dra.html). // If you have automatic export enabled and want to use an export data repository @@ -4882,6 +4882,8 @@ func (c *FSx) UpdateFileSystemRequest(input *UpdateFileSystemInput) (req *reques // // - LustreRootSquashConfiguration // +// - MetadataConfiguration +// // - PerUnitStorageThroughput // // - StorageCapacity @@ -8554,20 +8556,25 @@ type CreateFileSystemInput struct { // FileSystemType is a required field FileSystemType *string `type:"string" required:"true" enum:"FileSystemType"` - // (Optional) For FSx for Lustre file systems, sets the Lustre version for the - // file system that you're creating. Valid values are 2.10, 2.12, and 2.15: + // For FSx for Lustre file systems, sets the Lustre version for the file system + // that you're creating. Valid values are 2.10, 2.12, and 2.15: // // * 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. 2.12 or - // 2.15 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2. + // * 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. + // + // Default value is 2.10, except for the following deployments: // - // Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, - // then the default is 2.12. + // * Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without + // a metadata configuration mode. // - // If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment - // type, the CreateFileSystem operation fails. + // * Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with + // a metadata configuration mode. FileSystemTypeVersion *string `min:"1" type:"string"` // Specifies the ID of the Key Management Service (KMS) key to use for encrypting @@ -8624,7 +8631,7 @@ type CreateFileSystemInput struct { // configure depends on the value that you set for StorageType and the Lustre // DeploymentType, as follows: // - // * For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using + // * For 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. // @@ -8949,17 +8956,18 @@ type CreateFileSystemLustreConfiguration struct { // Choose 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 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) + // 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 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) // in the Amazon FSx for Lustre User Guide. // // If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the // CreateFileSystem operation fails. // // Encryption of data in transit is automatically turned on when you access - // SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 instances + // 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 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) @@ -9024,6 +9032,10 @@ type CreateFileSystemLustreConfiguration struct { // Logs. LogConfiguration *LustreLogCreateConfiguration `type:"structure"` + // The Lustre metadata performance configuration for the creation of an FSx + // for Lustre file system using a PERSISTENT_2 deployment type. + MetadataConfiguration *CreateFileSystemLustreMetadataConfiguration `type:"structure"` + // Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions // the amount of read and write throughput for each 1 tebibyte (TiB) of file // system storage capacity, in MB/s/TiB. File system throughput capacity is @@ -9096,6 +9108,11 @@ func (s *CreateFileSystemLustreConfiguration) Validate() error { invalidParams.AddNested("LogConfiguration", err.(request.ErrInvalidParams)) } } + if s.MetadataConfiguration != nil { + if err := s.MetadataConfiguration.Validate(); err != nil { + invalidParams.AddNested("MetadataConfiguration", err.(request.ErrInvalidParams)) + } + } if s.RootSquashConfiguration != nil { if err := s.RootSquashConfiguration.Validate(); err != nil { invalidParams.AddNested("RootSquashConfiguration", err.(request.ErrInvalidParams)) @@ -9174,6 +9191,12 @@ func (s *CreateFileSystemLustreConfiguration) SetLogConfiguration(v *LustreLogCr return s } +// SetMetadataConfiguration sets the MetadataConfiguration field's value. +func (s *CreateFileSystemLustreConfiguration) SetMetadataConfiguration(v *CreateFileSystemLustreMetadataConfiguration) *CreateFileSystemLustreConfiguration { + s.MetadataConfiguration = v + return s +} + // SetPerUnitStorageThroughput sets the PerUnitStorageThroughput field's value. func (s *CreateFileSystemLustreConfiguration) SetPerUnitStorageThroughput(v int64) *CreateFileSystemLustreConfiguration { s.PerUnitStorageThroughput = &v @@ -9192,6 +9215,89 @@ func (s *CreateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime(v st return s } +// The Lustre metadata performance configuration for the creation of an Amazon +// FSx for Lustre file system using a 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. +// +// After creation, the file system supports increasing metadata performance. +// For more information on Metadata IOPS, see Lustre metadata performance configuration +// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-metadata-performance.html#metadata-configuration) +// in the Amazon FSx for Lustre User Guide. +type CreateFileSystemLustreMetadataConfiguration struct { + _ struct{} `type:"structure"` + + // (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 1500, 3000, 6000, 12000, + // and multiples of 12000 up to a maximum of 192000. + // + // 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. + Iops *int64 `min:"1500" type:"integer"` + + // The metadata configuration mode for provisioning Metadata IOPS for an FSx + // for Lustre file system using a PERSISTENT_2 deployment type. + // + // * 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. + // + // Mode is a required field + Mode *string `type:"string" required:"true" enum:"MetadataConfigurationMode"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateFileSystemLustreMetadataConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateFileSystemLustreMetadataConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateFileSystemLustreMetadataConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFileSystemLustreMetadataConfiguration"} + if s.Iops != nil && *s.Iops < 1500 { + invalidParams.Add(request.NewErrParamMinValue("Iops", 1500)) + } + if s.Mode == nil { + invalidParams.Add(request.NewErrParamRequired("Mode")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIops sets the Iops field's value. +func (s *CreateFileSystemLustreMetadataConfiguration) SetIops(v int64) *CreateFileSystemLustreMetadataConfiguration { + s.Iops = &v + return s +} + +// SetMode sets the Mode field's value. +func (s *CreateFileSystemLustreMetadataConfiguration) SetMode(v string) *CreateFileSystemLustreMetadataConfiguration { + s.Mode = &v + return s +} + // The ONTAP configuration properties of the FSx for ONTAP file system that // you are creating. type CreateFileSystemOntapConfiguration struct { @@ -9250,7 +9356,7 @@ type CreateFileSystemOntapConfiguration struct { // 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 StorageCapacity, // Iops, and ThroughputCapacity. For more information, see High-availability - // (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html) + // (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs) // in the FSx for ONTAP user guide. // // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following @@ -10009,17 +10115,14 @@ type CreateOntapVolumeConfiguration struct { // * DP specifies a data-protection volume. A DP volume is read-only and // can be used as the destination of a NetApp SnapMirror relationship. // - // For more information, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types) + // For more information, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types) // in the Amazon FSx for NetApp ONTAP User Guide. OntapVolumeType *string `type:"string" enum:"InputOntapVolumeType"` // 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 - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style) - // in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following - // values: + // uses to control data access. Specify one of the following values: // // * 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 @@ -10033,7 +10136,7 @@ type CreateOntapVolumeConfiguration struct { // What the security styles and their effects are (https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html) // in the NetApp Documentation Center. // - // For more information, see Volume security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) + // For more information, see Volume security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) // in the FSx for ONTAP User Guide. SecurityStyle *string `type:"string" enum:"SecurityStyle"` @@ -10104,7 +10207,7 @@ type CreateOntapVolumeConfiguration struct { // 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 (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-styles.html) + // volumes. For more information, see Volume styles (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles) // in the Amazon FSx for NetApp ONTAP User Guide. VolumeStyle *string `type:"string" enum:"VolumeStyle"` } @@ -10840,8 +10943,8 @@ type CreateStorageVirtualMachineInput struct { // data uses a Microsoft Windows user as the service account. // // * MIXED This is an advanced setting. For more information, see Volume - // security style (fsx/latest/ONTAPGuide/volume-security-style.html) in the - // Amazon FSx for NetApp ONTAP User Guide. + // security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) + // in the Amazon FSx for NetApp ONTAP User Guide. RootVolumeSecurityStyle *string `type:"string" enum:"StorageVirtualMachineRootVolumeSecurityStyle"` // The password to use when managing the SVM using the NetApp ONTAP CLI or REST @@ -15635,7 +15738,7 @@ type FileCacheDataRepositoryAssociation struct { // * 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 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 + // in the format nfs://nfs-domain-name/exportpath. You can therefore link // a single NFS Export to a single data repository association. If you are // using the DataRepositorySubdirectories parameter, the path is the domain // name of the NFS file system in the format nfs://filer-domain-name, which @@ -16444,6 +16547,60 @@ func (s *FileSystemFailureDetails) SetMessage(v string) *FileSystemFailureDetail return s } +// The Lustre metadata performance configuration of an Amazon FSx for Lustre +// file system using a PERSISTENT_2 deployment type. The configuration enables +// the file system to support increasing metadata performance. +type FileSystemLustreMetadataConfiguration struct { + _ struct{} `type:"structure"` + + // The number of Metadata IOPS provisioned for the file system. Valid values + // are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000. + Iops *int64 `min:"1500" type:"integer"` + + // 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. + // + // Mode is a required field + Mode *string `type:"string" required:"true" enum:"MetadataConfigurationMode"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FileSystemLustreMetadataConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FileSystemLustreMetadataConfiguration) GoString() string { + return s.String() +} + +// SetIops sets the Iops field's value. +func (s *FileSystemLustreMetadataConfiguration) SetIops(v int64) *FileSystemLustreMetadataConfiguration { + s.Iops = &v + return s +} + +// SetMode sets the Mode field's value. +func (s *FileSystemLustreMetadataConfiguration) SetMode(v string) *FileSystemLustreMetadataConfiguration { + s.Mode = &v + return s +} + // No Amazon FSx file systems were found based upon supplied parameters. type FileSystemNotFound struct { _ struct{} `type:"structure"` @@ -17509,6 +17666,10 @@ type LustreFileSystemConfiguration struct { // for your file system to Amazon CloudWatch Logs. LogConfiguration *LustreLogConfiguration `type:"structure"` + // The Lustre metadata performance configuration for an Amazon FSx for Lustre + // file system using a PERSISTENT_2 deployment type. + MetadataConfiguration *FileSystemLustreMetadataConfiguration `type:"structure"` + // You use the MountName value when mounting the file system. // // For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, @@ -17607,6 +17768,12 @@ func (s *LustreFileSystemConfiguration) SetLogConfiguration(v *LustreLogConfigur return s } +// SetMetadataConfiguration sets the MetadataConfiguration field's value. +func (s *LustreFileSystemConfiguration) SetMetadataConfiguration(v *FileSystemLustreMetadataConfiguration) *LustreFileSystemConfiguration { + s.MetadataConfiguration = v + return s +} + // SetMountName sets the MountName field's value. func (s *LustreFileSystemConfiguration) SetMountName(v string) *LustreFileSystemConfiguration { s.MountName = &v @@ -20244,29 +20411,31 @@ func (s *SelfManagedActiveDirectoryConfiguration) SetUserName(v string) *SelfMan } // 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. +// configuration to which an FSx for Windows File Server file system or an FSx +// for ONTAP SVM is joined. type SelfManagedActiveDirectoryConfigurationUpdates struct { _ struct{} `type:"structure"` // A list of up to three DNS server or domain controller IP addresses in your - // self-managed AD domain. + // self-managed Active Directory domain. DnsIps []*string `min:"1" type:"list"` - // 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. DomainName *string `min:"1" type:"string"` - // 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. FileSystemAdministratorsGroup *string `min:"1" type:"string"` // Specifies an updated fully qualified distinguished name of the organization - // unit within your self-managed AD. + // unit within your self-managed Active Directory. OrganizationalUnitDistinguishedName *string `min:"1" type:"string"` // 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. + // Active Directory domain. Amazon FSx uses this account to join to your self-managed + // Active Directory domain. // // Password is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SelfManagedActiveDirectoryConfigurationUpdates's @@ -20274,7 +20443,8 @@ type SelfManagedActiveDirectoryConfigurationUpdates struct { Password *string `min:"1" type:"string" sensitive:"true"` // 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. + // 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 OrganizationalUnitDistinguishedName. @@ -22390,6 +22560,11 @@ type UpdateFileSystemLustreConfiguration struct { // Logs. LogConfiguration *LustreLogCreateConfiguration `type:"structure"` + // The Lustre metadata performance configuration for an Amazon FSx for Lustre + // file system using a PERSISTENT_2 deployment type. When this configuration + // is enabled, the file system supports increasing metadata performance. + MetadataConfiguration *UpdateFileSystemLustreMetadataConfiguration `type:"structure"` + // 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 @@ -22450,6 +22625,11 @@ func (s *UpdateFileSystemLustreConfiguration) Validate() error { invalidParams.AddNested("LogConfiguration", err.(request.ErrInvalidParams)) } } + if s.MetadataConfiguration != nil { + if err := s.MetadataConfiguration.Validate(); err != nil { + invalidParams.AddNested("MetadataConfiguration", err.(request.ErrInvalidParams)) + } + } if s.RootSquashConfiguration != nil { if err := s.RootSquashConfiguration.Validate(); err != nil { invalidParams.AddNested("RootSquashConfiguration", err.(request.ErrInvalidParams)) @@ -22492,6 +22672,12 @@ func (s *UpdateFileSystemLustreConfiguration) SetLogConfiguration(v *LustreLogCr return s } +// SetMetadataConfiguration sets the MetadataConfiguration field's value. +func (s *UpdateFileSystemLustreConfiguration) SetMetadataConfiguration(v *UpdateFileSystemLustreMetadataConfiguration) *UpdateFileSystemLustreConfiguration { + s.MetadataConfiguration = v + return s +} + // SetPerUnitStorageThroughput sets the PerUnitStorageThroughput field's value. func (s *UpdateFileSystemLustreConfiguration) SetPerUnitStorageThroughput(v int64) *UpdateFileSystemLustreConfiguration { s.PerUnitStorageThroughput = &v @@ -22510,6 +22696,82 @@ func (s *UpdateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime(v st return s } +// The Lustre metadata performance configuration update for an Amazon FSx for +// Lustre file system using a 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 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-metadata-performance.html) +// in the Amazon FSx for Lustre User Guide. +type UpdateFileSystemLustreMetadataConfiguration struct { + _ struct{} `type:"structure"` + + // (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision + // for your file system. Valid values are 1500, 3000, 6000, 12000, and multiples + // of 12000 up to a maximum of 192000. + // + // The value you provide must be greater than or equal to the current number + // of Metadata IOPS provisioned for the file system. + Iops *int64 `min:"1500" type:"integer"` + + // The metadata configuration mode for provisioning Metadata IOPS for an FSx + // for Lustre file system using a PERSISTENT_2 deployment type. + // + // * To increase the Metadata IOPS or to switch from AUTOMATIC mode, specify + // 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. + // + // * To switch from USER_PROVISIONED mode, specify AUTOMATIC as the value + // for this parameter, but do not input a value for Iops. 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. + Mode *string `type:"string" enum:"MetadataConfigurationMode"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFileSystemLustreMetadataConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFileSystemLustreMetadataConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateFileSystemLustreMetadataConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateFileSystemLustreMetadataConfiguration"} + if s.Iops != nil && *s.Iops < 1500 { + invalidParams.Add(request.NewErrParamMinValue("Iops", 1500)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIops sets the Iops field's value. +func (s *UpdateFileSystemLustreMetadataConfiguration) SetIops(v int64) *UpdateFileSystemLustreMetadataConfiguration { + s.Iops = &v + return s +} + +// SetMode sets the Mode field's value. +func (s *UpdateFileSystemLustreMetadataConfiguration) SetMode(v string) *UpdateFileSystemLustreMetadataConfiguration { + s.Mode = &v + return s +} + // The configuration updates for an Amazon FSx for NetApp ONTAP file system. type UpdateFileSystemOntapConfiguration struct { _ struct{} `type:"structure"` @@ -23785,8 +24047,8 @@ type UpdateSvmActiveDirectoryConfiguration struct { NetBiosName *string `min:"1" type:"string"` // 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. + // configuration to which an FSx for Windows File Server file system or an FSx + // for ONTAP SVM is joined. SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates `type:"structure"` } @@ -25440,6 +25702,22 @@ func LustreDeploymentType_Values() []string { } } +const ( + // MetadataConfigurationModeAutomatic is a MetadataConfigurationMode enum value + MetadataConfigurationModeAutomatic = "AUTOMATIC" + + // MetadataConfigurationModeUserProvisioned is a MetadataConfigurationMode enum value + MetadataConfigurationModeUserProvisioned = "USER_PROVISIONED" +) + +// MetadataConfigurationMode_Values returns all elements of the MetadataConfigurationMode enum +func MetadataConfigurationMode_Values() []string { + return []string{ + MetadataConfigurationModeAutomatic, + MetadataConfigurationModeUserProvisioned, + } +} + const ( // NfsVersionNfs3 is a NfsVersion enum value NfsVersionNfs3 = "NFS3" diff --git a/service/glue/api.go b/service/glue/api.go index 4df57b13995..5cba7104fdd 100644 --- a/service/glue/api.go +++ b/service/glue/api.go @@ -72862,6 +72862,10 @@ type TableInput struct { // A TableIdentifier structure that describes a target table for resource linking. TargetTable *TableIdentifier `type:"structure"` + // A structure that contains all the information that defines the view, including + // the dialect or dialects for the view, and the query. + ViewDefinition *ViewDefinitionInput_ `type:"structure"` + // Included for Apache Hive compatibility. Not used in the normal course of // Glue operations. ViewExpandedText *string `type:"string"` @@ -72922,6 +72926,11 @@ func (s *TableInput) Validate() error { invalidParams.AddNested("TargetTable", err.(request.ErrInvalidParams)) } } + if s.ViewDefinition != nil { + if err := s.ViewDefinition.Validate(); err != nil { + invalidParams.AddNested("ViewDefinition", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -72995,6 +73004,12 @@ func (s *TableInput) SetTargetTable(v *TableIdentifier) *TableInput { return s } +// SetViewDefinition sets the ViewDefinition field's value. +func (s *TableInput) SetViewDefinition(v *ViewDefinitionInput_) *TableInput { + s.ViewDefinition = v + return s +} + // SetViewExpandedText sets the ViewExpandedText field's value. func (s *TableInput) SetViewExpandedText(v string) *TableInput { s.ViewExpandedText = &v @@ -77177,6 +77192,10 @@ type UpdateTableInput struct { // DatabaseName is a required field DatabaseName *string `min:"1" type:"string" required:"true"` + // A flag that can be set to true to ignore matching storage descriptor and + // subobject matching requirements. + Force *bool `type:"boolean"` + // By default, UpdateTable always creates an archived version of the table before // updating it. However, if skipArchive is set to true, UpdateTable does not // create the archived version. @@ -77192,6 +77211,9 @@ type UpdateTableInput struct { // The version ID at which to update the table contents. VersionId *string `min:"1" type:"string"` + + // The operation to be performed when updating the view. + ViewUpdateAction *string `type:"string" enum:"ViewUpdateAction"` } // String returns the string representation. @@ -77257,6 +77279,12 @@ func (s *UpdateTableInput) SetDatabaseName(v string) *UpdateTableInput { return s } +// SetForce sets the Force field's value. +func (s *UpdateTableInput) SetForce(v bool) *UpdateTableInput { + s.Force = &v + return s +} + // SetSkipArchive sets the SkipArchive field's value. func (s *UpdateTableInput) SetSkipArchive(v bool) *UpdateTableInput { s.SkipArchive = &v @@ -77281,6 +77309,12 @@ func (s *UpdateTableInput) SetVersionId(v string) *UpdateTableInput { return s } +// SetViewUpdateAction sets the ViewUpdateAction field's value. +func (s *UpdateTableInput) SetViewUpdateAction(v string) *UpdateTableInput { + s.ViewUpdateAction = &v + return s +} + type UpdateTableOptimizerInput struct { _ struct{} `type:"structure"` @@ -78277,6 +78311,95 @@ func (s *ViewDefinition) SetSubObjects(v []*string) *ViewDefinition { return s } +// A structure containing details for creating or updating an Glue view. +type ViewDefinitionInput_ struct { + _ struct{} `type:"structure"` + + // The definer of a view in SQL. + Definer *string `min:"20" type:"string"` + + // 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. + IsProtected *bool `type:"boolean"` + + // A list of structures that contains the dialect of the view, and the query + // that defines the view. + Representations []*ViewRepresentationInput_ `min:"1" type:"list"` + + // A list of base table ARNs that make up the view. + SubObjects []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ViewDefinitionInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ViewDefinitionInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ViewDefinitionInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ViewDefinitionInput_"} + if s.Definer != nil && len(*s.Definer) < 20 { + invalidParams.Add(request.NewErrParamMinLen("Definer", 20)) + } + if s.Representations != nil && len(s.Representations) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Representations", 1)) + } + if s.Representations != nil { + for i, v := range s.Representations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Representations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDefiner sets the Definer field's value. +func (s *ViewDefinitionInput_) SetDefiner(v string) *ViewDefinitionInput_ { + s.Definer = &v + return s +} + +// SetIsProtected sets the IsProtected field's value. +func (s *ViewDefinitionInput_) SetIsProtected(v bool) *ViewDefinitionInput_ { + s.IsProtected = &v + return s +} + +// SetRepresentations sets the Representations field's value. +func (s *ViewDefinitionInput_) SetRepresentations(v []*ViewRepresentationInput_) *ViewDefinitionInput_ { + s.Representations = v + return s +} + +// SetSubObjects sets the SubObjects field's value. +func (s *ViewDefinitionInput_) SetSubObjects(v []*string) *ViewDefinitionInput_ { + s.SubObjects = v + return s +} + // A structure that contains the dialect of the view, and the query that defines // the view. type ViewRepresentation struct { @@ -78292,6 +78415,10 @@ type ViewRepresentation struct { // can be queried in their respective query engines. IsStale *bool `type:"boolean"` + // The name of the connection to be used to validate the specific representation + // of the view. + ValidationConnection *string `min:"1" type:"string"` + // 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 ViewOriginalText to ViewExpandedText. For example: @@ -78342,6 +78469,12 @@ func (s *ViewRepresentation) SetIsStale(v bool) *ViewRepresentation { return s } +// SetValidationConnection sets the ValidationConnection field's value. +func (s *ViewRepresentation) SetValidationConnection(v string) *ViewRepresentation { + s.ValidationConnection = &v + return s +} + // SetViewExpandedText sets the ViewExpandedText field's value. func (s *ViewRepresentation) SetViewExpandedText(v string) *ViewRepresentation { s.ViewExpandedText = &v @@ -78354,6 +78487,93 @@ func (s *ViewRepresentation) SetViewOriginalText(v string) *ViewRepresentation { return s } +// A structure containing details of a representation to update or create a +// Lake Formation view. +type ViewRepresentationInput_ struct { + _ struct{} `type:"structure"` + + // A parameter that specifies the engine type of a specific representation. + Dialect *string `type:"string" enum:"ViewDialect"` + + // A parameter that specifies the version of the engine of a specific representation. + DialectVersion *string `min:"1" type:"string"` + + // The name of the connection to be used to validate the specific representation + // of the view. + ValidationConnection *string `min:"1" type:"string"` + + // A string that represents the SQL query that describes the view with expanded + // resource ARNs + ViewExpandedText *string `type:"string"` + + // A string that represents the original SQL query that describes the view. + ViewOriginalText *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ViewRepresentationInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ViewRepresentationInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ViewRepresentationInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ViewRepresentationInput_"} + if s.DialectVersion != nil && len(*s.DialectVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DialectVersion", 1)) + } + if s.ValidationConnection != nil && len(*s.ValidationConnection) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ValidationConnection", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDialect sets the Dialect field's value. +func (s *ViewRepresentationInput_) SetDialect(v string) *ViewRepresentationInput_ { + s.Dialect = &v + return s +} + +// SetDialectVersion sets the DialectVersion field's value. +func (s *ViewRepresentationInput_) SetDialectVersion(v string) *ViewRepresentationInput_ { + s.DialectVersion = &v + return s +} + +// SetValidationConnection sets the ValidationConnection field's value. +func (s *ViewRepresentationInput_) SetValidationConnection(v string) *ViewRepresentationInput_ { + s.ValidationConnection = &v + return s +} + +// SetViewExpandedText sets the ViewExpandedText field's value. +func (s *ViewRepresentationInput_) SetViewExpandedText(v string) *ViewRepresentationInput_ { + s.ViewExpandedText = &v + return s +} + +// SetViewOriginalText sets the ViewOriginalText field's value. +func (s *ViewRepresentationInput_) SetViewOriginalText(v string) *ViewRepresentationInput_ { + s.ViewOriginalText = &v + return s +} + // A workflow is a collection of multiple dependent Glue jobs and crawlers that // are run to complete a complex ETL task. A workflow manages the execution // and monitoring of all its jobs and crawlers. @@ -81348,6 +81568,30 @@ func ViewDialect_Values() []string { } } +const ( + // ViewUpdateActionAdd is a ViewUpdateAction enum value + ViewUpdateActionAdd = "ADD" + + // ViewUpdateActionReplace is a ViewUpdateAction enum value + ViewUpdateActionReplace = "REPLACE" + + // ViewUpdateActionAddOrReplace is a ViewUpdateAction enum value + ViewUpdateActionAddOrReplace = "ADD_OR_REPLACE" + + // ViewUpdateActionDrop is a ViewUpdateAction enum value + ViewUpdateActionDrop = "DROP" +) + +// ViewUpdateAction_Values returns all elements of the ViewUpdateAction enum +func ViewUpdateAction_Values() []string { + return []string{ + ViewUpdateActionAdd, + ViewUpdateActionReplace, + ViewUpdateActionAddOrReplace, + ViewUpdateActionDrop, + } +} + const ( // WorkerTypeStandard is a WorkerType enum value WorkerTypeStandard = "Standard" diff --git a/service/iotwireless/api.go b/service/iotwireless/api.go index 079410b712d..f9e9ae96e49 100644 --- a/service/iotwireless/api.go +++ b/service/iotwireless/api.go @@ -31651,6 +31651,9 @@ const ( // FuotaDeviceStatusSuccessful is a FuotaDeviceStatus enum value FuotaDeviceStatusSuccessful = "Successful" + + // FuotaDeviceStatusDeviceExistInConflictFuotaTask is a FuotaDeviceStatus enum value + FuotaDeviceStatusDeviceExistInConflictFuotaTask = "Device_exist_in_conflict_fuota_task" ) // FuotaDeviceStatus_Values returns all elements of the FuotaDeviceStatus enum @@ -31667,6 +31670,7 @@ func FuotaDeviceStatus_Values() []string { FuotaDeviceStatusMemoryError, FuotaDeviceStatusMicerror, FuotaDeviceStatusSuccessful, + FuotaDeviceStatusDeviceExistInConflictFuotaTask, } } diff --git a/service/locationservice/api.go b/service/locationservice/api.go index ce2799a7f10..a63052f9204 100644 --- a/service/locationservice/api.go +++ b/service/locationservice/api.go @@ -2870,6 +2870,168 @@ func (c *LocationService) DisassociateTrackerConsumerWithContext(ctx aws.Context return out, req.Send() } +const opForecastGeofenceEvents = "ForecastGeofenceEvents" + +// ForecastGeofenceEventsRequest generates a "aws/request.Request" representing the +// client's request for the ForecastGeofenceEvents operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ForecastGeofenceEvents for more information on using the ForecastGeofenceEvents +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ForecastGeofenceEventsRequest method. +// req, resp := client.ForecastGeofenceEventsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ForecastGeofenceEvents +func (c *LocationService) ForecastGeofenceEventsRequest(input *ForecastGeofenceEventsInput) (req *request.Request, output *ForecastGeofenceEventsOutput) { + op := &request.Operation{ + Name: opForecastGeofenceEvents, + HTTPMethod: "POST", + HTTPPath: "/geofencing/v0/collections/{CollectionName}/forecast-geofence-events", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ForecastGeofenceEventsInput{} + } + + output = &ForecastGeofenceEventsOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("geofencing.", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// ForecastGeofenceEvents API operation for Amazon Location Service. +// +// 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: +// +// 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. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Location Service's +// API operation ForecastGeofenceEvents for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// The request has failed to process because of an unknown server error, exception, +// or failure. +// +// - ResourceNotFoundException +// The resource that you've entered was not found in your AWS account. +// +// - AccessDeniedException +// The request was denied because of insufficient access or permissions. Check +// with an administrator to verify your permissions. +// +// - ValidationException +// The input failed to meet the constraints specified by the AWS service. +// +// - ThrottlingException +// The request was denied because of request throttling. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ForecastGeofenceEvents +func (c *LocationService) ForecastGeofenceEvents(input *ForecastGeofenceEventsInput) (*ForecastGeofenceEventsOutput, error) { + req, out := c.ForecastGeofenceEventsRequest(input) + return out, req.Send() +} + +// ForecastGeofenceEventsWithContext is the same as ForecastGeofenceEvents with the addition of +// the ability to pass a context and additional request options. +// +// See ForecastGeofenceEvents for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LocationService) ForecastGeofenceEventsWithContext(ctx aws.Context, input *ForecastGeofenceEventsInput, opts ...request.Option) (*ForecastGeofenceEventsOutput, error) { + req, out := c.ForecastGeofenceEventsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ForecastGeofenceEventsPages iterates over the pages of a ForecastGeofenceEvents operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ForecastGeofenceEvents method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ForecastGeofenceEvents operation. +// pageNum := 0 +// err := client.ForecastGeofenceEventsPages(params, +// func(page *locationservice.ForecastGeofenceEventsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *LocationService) ForecastGeofenceEventsPages(input *ForecastGeofenceEventsInput, fn func(*ForecastGeofenceEventsOutput, bool) bool) error { + return c.ForecastGeofenceEventsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ForecastGeofenceEventsPagesWithContext same as ForecastGeofenceEventsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LocationService) ForecastGeofenceEventsPagesWithContext(ctx aws.Context, input *ForecastGeofenceEventsInput, fn func(*ForecastGeofenceEventsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ForecastGeofenceEventsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ForecastGeofenceEventsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ForecastGeofenceEventsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opGetDevicePosition = "GetDevicePosition" // GetDevicePositionRequest generates a "aws/request.Request" representing the @@ -3169,6 +3331,9 @@ func (c *LocationService) GetGeofenceRequest(input *GetGeofenceInput) (req *requ // // Retrieves the geofence details from a geofence collection. // +// The returned geometry will always match the geometry format used when the +// geofence was created. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6337,6 +6502,103 @@ func (c *LocationService) UpdateTrackerWithContext(ctx aws.Context, input *Updat return out, req.Send() } +const opVerifyDevicePosition = "VerifyDevicePosition" + +// VerifyDevicePositionRequest generates a "aws/request.Request" representing the +// client's request for the VerifyDevicePosition operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See VerifyDevicePosition for more information on using the VerifyDevicePosition +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the VerifyDevicePositionRequest method. +// req, resp := client.VerifyDevicePositionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/VerifyDevicePosition +func (c *LocationService) VerifyDevicePositionRequest(input *VerifyDevicePositionInput) (req *request.Request, output *VerifyDevicePositionOutput) { + op := &request.Operation{ + Name: opVerifyDevicePosition, + HTTPMethod: "POST", + HTTPPath: "/tracking/v0/trackers/{TrackerName}/positions/verify", + } + + if input == nil { + input = &VerifyDevicePositionInput{} + } + + output = &VerifyDevicePositionOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("tracking.", nil)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// VerifyDevicePosition API operation for Amazon Location Service. +// +// 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. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Location Service's +// API operation VerifyDevicePosition for usage and error information. +// +// Returned Error Types: +// +// - InternalServerException +// The request has failed to process because of an unknown server error, exception, +// or failure. +// +// - ResourceNotFoundException +// The resource that you've entered was not found in your AWS account. +// +// - AccessDeniedException +// The request was denied because of insufficient access or permissions. Check +// with an administrator to verify your permissions. +// +// - ValidationException +// The input failed to meet the constraints specified by the AWS service. +// +// - ThrottlingException +// The request was denied because of request throttling. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/VerifyDevicePosition +func (c *LocationService) VerifyDevicePosition(input *VerifyDevicePositionInput) (*VerifyDevicePositionOutput, error) { + req, out := c.VerifyDevicePositionRequest(input) + return out, req.Send() +} + +// VerifyDevicePositionWithContext is the same as VerifyDevicePosition with the addition of +// the ability to pass a context and additional request options. +// +// See VerifyDevicePosition for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LocationService) VerifyDevicePositionWithContext(ctx aws.Context, input *VerifyDevicePositionInput, opts ...request.Option) (*VerifyDevicePositionOutput, error) { + req, out := c.VerifyDevicePositionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // The request was denied because of insufficient access or permissions. Check // with an administrator to verify your permissions. type AccessDeniedException struct { @@ -7504,11 +7766,13 @@ type BatchPutGeofenceRequestEntry struct { // String and GoString methods. GeofenceProperties map[string]*string `type:"map" sensitive:"true"` - // Contains the details of the position of the geofence. Can be either a polygon - // or a circle. Including both will return a validation error. + // 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. // - // Each geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) - // can have a maximum of 1,000 vertices. + // The geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // format supports a maximum of 1,000 vertices. The Geofence geobuf (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // format supports a maximum of 100,000 vertices. // // Geometry is a required field Geometry *GeofenceGeometry `type:"structure" required:"true"` @@ -8753,6 +9017,67 @@ func (s *CalculateRouteTruckModeOptions) SetWeight(v *TruckWeight) *CalculateRou return s } +// The cellular network communication infrastructure that the device uses. +type CellSignals struct { + _ struct{} `type:"structure"` + + // Information about the Long-Term Evolution (LTE) network the device is connected + // to. + // + // LteCellDetails is a required field + LteCellDetails []*LteCellDetails `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CellSignals) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CellSignals) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CellSignals) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CellSignals"} + if s.LteCellDetails == nil { + invalidParams.Add(request.NewErrParamRequired("LteCellDetails")) + } + if s.LteCellDetails != nil && len(s.LteCellDetails) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LteCellDetails", 1)) + } + if s.LteCellDetails != nil { + for i, v := range s.LteCellDetails { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "LteCellDetails", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLteCellDetails sets the LteCellDetails field's value. +func (s *CellSignals) SetLteCellDetails(v []*LteCellDetails) *CellSignals { + s.LteCellDetails = v + return s +} + // A circle on the earth, as defined by a center point and a radius. type Circle struct { _ struct{} `type:"structure" sensitive:"true"` @@ -11957,25 +12282,167 @@ func (s *DevicePositionUpdate) SetSampleTime(v time.Time) *DevicePositionUpdate return s } -type DisassociateTrackerConsumerInput struct { - _ struct{} `type:"structure" nopayload:"true"` +// The device's position, IP address, and Wi-Fi access points. +type DeviceState struct { + _ struct{} `type:"structure"` - // 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: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer - // - // ConsumerArn is a required field - ConsumerArn *string `location:"uri" locationName:"ConsumerArn" type:"string" required:"true"` + // Defines the level of certainty of the position. + Accuracy *PositionalAccuracy `type:"structure"` - // The name of the tracker resource to be dissociated from the consumer. + // The cellular network infrastructure that the device is connected to. + CellSignals *CellSignals `type:"structure"` + + // The device identifier. // - // TrackerName is a required field - TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` -} + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` -// String returns the string representation. + // The device's Ipv4 address. + Ipv4Address *string `type:"string"` + + // The last known device position. + // + // Position is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DeviceState's + // String and GoString methods. + // + // Position is a required field + Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // The timestamp at which the device's position was determined. Uses ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. + // + // SampleTime is a required field + SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The Wi-Fi access points the device is using. + WiFiAccessPoints []*WiFiAccessPoint `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceState) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceState) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeviceState) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeviceState"} + if s.DeviceId == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceId")) + } + if s.DeviceId != nil && len(*s.DeviceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceId", 1)) + } + if s.Position == nil { + invalidParams.Add(request.NewErrParamRequired("Position")) + } + if s.Position != nil && len(s.Position) < 2 { + invalidParams.Add(request.NewErrParamMinLen("Position", 2)) + } + if s.SampleTime == nil { + invalidParams.Add(request.NewErrParamRequired("SampleTime")) + } + if s.Accuracy != nil { + if err := s.Accuracy.Validate(); err != nil { + invalidParams.AddNested("Accuracy", err.(request.ErrInvalidParams)) + } + } + if s.CellSignals != nil { + if err := s.CellSignals.Validate(); err != nil { + invalidParams.AddNested("CellSignals", err.(request.ErrInvalidParams)) + } + } + if s.WiFiAccessPoints != nil { + for i, v := range s.WiFiAccessPoints { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "WiFiAccessPoints", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccuracy sets the Accuracy field's value. +func (s *DeviceState) SetAccuracy(v *PositionalAccuracy) *DeviceState { + s.Accuracy = v + return s +} + +// SetCellSignals sets the CellSignals field's value. +func (s *DeviceState) SetCellSignals(v *CellSignals) *DeviceState { + s.CellSignals = v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DeviceState) SetDeviceId(v string) *DeviceState { + s.DeviceId = &v + return s +} + +// SetIpv4Address sets the Ipv4Address field's value. +func (s *DeviceState) SetIpv4Address(v string) *DeviceState { + s.Ipv4Address = &v + return s +} + +// SetPosition sets the Position field's value. +func (s *DeviceState) SetPosition(v []*float64) *DeviceState { + s.Position = v + return s +} + +// SetSampleTime sets the SampleTime field's value. +func (s *DeviceState) SetSampleTime(v time.Time) *DeviceState { + s.SampleTime = &v + return s +} + +// SetWiFiAccessPoints sets the WiFiAccessPoints field's value. +func (s *DeviceState) SetWiFiAccessPoints(v []*WiFiAccessPoint) *DeviceState { + s.WiFiAccessPoints = v + return s +} + +type DisassociateTrackerConsumerInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // 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: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer + // + // ConsumerArn is a required field + ConsumerArn *string `location:"uri" locationName:"ConsumerArn" type:"string" required:"true"` + + // The name of the tracker resource to be dissociated from the consumer. + // + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. // // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the @@ -12040,19 +12507,391 @@ func (s DisassociateTrackerConsumerOutput) String() string { return awsutil.Prettify(s) } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DisassociateTrackerConsumerOutput) GoString() string { - return s.String() +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DisassociateTrackerConsumerOutput) GoString() string { + return s.String() +} + +// The device's position, IP address, and WiFi access points. +type ForecastGeofenceEventsDeviceState struct { + _ struct{} `type:"structure"` + + // The device's position. + // + // Position is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ForecastGeofenceEventsDeviceState's + // String and GoString methods. + // + // Position is a required field + Position []*float64 `min:"2" type:"list" required:"true" sensitive:"true"` + + // The device's speed. + Speed *float64 `type:"double"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastGeofenceEventsDeviceState) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastGeofenceEventsDeviceState) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ForecastGeofenceEventsDeviceState) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ForecastGeofenceEventsDeviceState"} + if s.Position == nil { + invalidParams.Add(request.NewErrParamRequired("Position")) + } + if s.Position != nil && len(s.Position) < 2 { + invalidParams.Add(request.NewErrParamMinLen("Position", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPosition sets the Position field's value. +func (s *ForecastGeofenceEventsDeviceState) SetPosition(v []*float64) *ForecastGeofenceEventsDeviceState { + s.Position = v + return s +} + +// SetSpeed sets the Speed field's value. +func (s *ForecastGeofenceEventsDeviceState) SetSpeed(v float64) *ForecastGeofenceEventsDeviceState { + s.Speed = &v + return s +} + +type ForecastGeofenceEventsInput struct { + _ struct{} `type:"structure"` + + // The name of the geofence collection. + // + // CollectionName is a required field + CollectionName *string `location:"uri" locationName:"CollectionName" min:"1" type:"string" required:"true"` + + // The device's state, including current position and speed. + // + // DeviceState is a required field + DeviceState *ForecastGeofenceEventsDeviceState `type:"structure" required:"true"` + + // The distance unit used for the 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. + // + // Default Value: Kilometers + DistanceUnit *string `type:"string" enum:"DistanceUnit"` + + // An optional limit for the number of resources returned in a single call. + // + // Default value: 20 + MaxResults *int64 `min:"1" type:"integer"` + + // 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: null + NextToken *string `min:"1" type:"string"` + + // The speed unit for the device captured by the device state. The measurement + // system must match for DistanceUnit and SpeedUnit; if Kilometers is specified + // for DistanceUnit, then SpeedUnit must be KilometersPerHour. + // + // Default Value: KilometersPerHour. + SpeedUnit *string `type:"string" enum:"SpeedUnit"` + + // Specifies the time horizon in minutes for the forecasted events. + TimeHorizonMinutes *float64 `type:"double"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastGeofenceEventsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastGeofenceEventsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ForecastGeofenceEventsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ForecastGeofenceEventsInput"} + if s.CollectionName == nil { + invalidParams.Add(request.NewErrParamRequired("CollectionName")) + } + if s.CollectionName != nil && len(*s.CollectionName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CollectionName", 1)) + } + if s.DeviceState == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceState")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.DeviceState != nil { + if err := s.DeviceState.Validate(); err != nil { + invalidParams.AddNested("DeviceState", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCollectionName sets the CollectionName field's value. +func (s *ForecastGeofenceEventsInput) SetCollectionName(v string) *ForecastGeofenceEventsInput { + s.CollectionName = &v + return s +} + +// SetDeviceState sets the DeviceState field's value. +func (s *ForecastGeofenceEventsInput) SetDeviceState(v *ForecastGeofenceEventsDeviceState) *ForecastGeofenceEventsInput { + s.DeviceState = v + return s +} + +// SetDistanceUnit sets the DistanceUnit field's value. +func (s *ForecastGeofenceEventsInput) SetDistanceUnit(v string) *ForecastGeofenceEventsInput { + s.DistanceUnit = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ForecastGeofenceEventsInput) SetMaxResults(v int64) *ForecastGeofenceEventsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ForecastGeofenceEventsInput) SetNextToken(v string) *ForecastGeofenceEventsInput { + s.NextToken = &v + return s +} + +// SetSpeedUnit sets the SpeedUnit field's value. +func (s *ForecastGeofenceEventsInput) SetSpeedUnit(v string) *ForecastGeofenceEventsInput { + s.SpeedUnit = &v + return s +} + +// SetTimeHorizonMinutes sets the TimeHorizonMinutes field's value. +func (s *ForecastGeofenceEventsInput) SetTimeHorizonMinutes(v float64) *ForecastGeofenceEventsInput { + s.TimeHorizonMinutes = &v + return s +} + +type ForecastGeofenceEventsOutput struct { + _ struct{} `type:"structure"` + + // The distance unit for the forecasted events. + // + // DistanceUnit is a required field + DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"` + + // The list of forecasted events. + // + // ForecastedEvents is a required field + ForecastedEvents []*ForecastedEvent `type:"list" required:"true"` + + // 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. + NextToken *string `min:"1" type:"string"` + + // The speed unit for the forecasted events. + // + // SpeedUnit is a required field + SpeedUnit *string `type:"string" required:"true" enum:"SpeedUnit"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastGeofenceEventsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastGeofenceEventsOutput) GoString() string { + return s.String() +} + +// SetDistanceUnit sets the DistanceUnit field's value. +func (s *ForecastGeofenceEventsOutput) SetDistanceUnit(v string) *ForecastGeofenceEventsOutput { + s.DistanceUnit = &v + return s +} + +// SetForecastedEvents sets the ForecastedEvents field's value. +func (s *ForecastGeofenceEventsOutput) SetForecastedEvents(v []*ForecastedEvent) *ForecastGeofenceEventsOutput { + s.ForecastedEvents = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ForecastGeofenceEventsOutput) SetNextToken(v string) *ForecastGeofenceEventsOutput { + s.NextToken = &v + return s +} + +// SetSpeedUnit sets the SpeedUnit field's value. +func (s *ForecastGeofenceEventsOutput) SetSpeedUnit(v string) *ForecastGeofenceEventsOutput { + s.SpeedUnit = &v + return s +} + +// 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. +type ForecastedEvent struct { + _ struct{} `type:"structure"` + + // The forecasted event identifier. + // + // EventId is a required field + EventId *string `type:"string" required:"true"` + + // The event type, forecasting three states for which a device can be in relative + // to a geofence: + // + // 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. + // + // EventType is a required field + EventType *string `type:"string" required:"true" enum:"ForecastedGeofenceEventType"` + + // The forecasted time the device will breach the geofence in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ + ForecastedBreachTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` + + // The geofence identifier pertaining to the forecasted event. + // + // GeofenceId is a required field + GeofenceId *string `min:"1" type:"string" required:"true"` + + // The geofence properties. + // + // GeofenceProperties is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ForecastedEvent's + // String and GoString methods. + GeofenceProperties map[string]*string `type:"map" sensitive:"true"` + + // Indicates if the device is located within the geofence. + // + // IsDeviceInGeofence is a required field + IsDeviceInGeofence *bool `type:"boolean" required:"true"` + + // The closest distance from the device's position to the geofence. + // + // NearestDistance is a required field + NearestDistance *float64 `type:"double" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastedEvent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForecastedEvent) GoString() string { + return s.String() +} + +// SetEventId sets the EventId field's value. +func (s *ForecastedEvent) SetEventId(v string) *ForecastedEvent { + s.EventId = &v + return s +} + +// SetEventType sets the EventType field's value. +func (s *ForecastedEvent) SetEventType(v string) *ForecastedEvent { + s.EventType = &v + return s +} + +// SetForecastedBreachTime sets the ForecastedBreachTime field's value. +func (s *ForecastedEvent) SetForecastedBreachTime(v time.Time) *ForecastedEvent { + s.ForecastedBreachTime = &v + return s +} + +// SetGeofenceId sets the GeofenceId field's value. +func (s *ForecastedEvent) SetGeofenceId(v string) *ForecastedEvent { + s.GeofenceId = &v + return s +} + +// SetGeofenceProperties sets the GeofenceProperties field's value. +func (s *ForecastedEvent) SetGeofenceProperties(v map[string]*string) *ForecastedEvent { + s.GeofenceProperties = v + return s +} + +// SetIsDeviceInGeofence sets the IsDeviceInGeofence field's value. +func (s *ForecastedEvent) SetIsDeviceInGeofence(v bool) *ForecastedEvent { + s.IsDeviceInGeofence = &v + return s +} + +// SetNearestDistance sets the NearestDistance field's value. +func (s *ForecastedEvent) SetNearestDistance(v float64) *ForecastedEvent { + s.NearestDistance = &v + return s } // 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. +// 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. @@ -12066,6 +12905,18 @@ type GeofenceGeometry struct { // String and GoString methods. Circle *Circle `type:"structure" sensitive:"true"` + // 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. + // + // Geobuf is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GeofenceGeometry's + // String and GoString methods. + // + // Geobuf is automatically base64 encoded/decoded by the SDK. + Geobuf []byte `type:"blob" sensitive:"true"` + // 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: [longitude, latitude]. @@ -12127,6 +12978,12 @@ func (s *GeofenceGeometry) SetCircle(v *Circle) *GeofenceGeometry { return s } +// SetGeobuf sets the Geobuf field's value. +func (s *GeofenceGeometry) SetGeobuf(v []byte) *GeofenceGeometry { + s.Geobuf = v + return s +} + // SetPolygon sets the Polygon field's value. func (s *GeofenceGeometry) SetPolygon(v [][][]*float64) *GeofenceGeometry { s.Polygon = v @@ -12393,8 +13250,8 @@ type GetDevicePositionOutput struct { // String and GoString methods. PositionProperties map[string]*string `type:"map" sensitive:"true"` - // The timestamp for when the tracker resource received the device position - // in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // The timestamp for when the tracker resource received the device position. + // Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: // YYYY-MM-DDThh:mm:ss.sssZ. // // ReceivedTime is a required field @@ -12653,8 +13510,7 @@ type GetMapGlyphsInput struct { // // * VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold // - // * VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold | - // Arial Unicode MS Bold | Arial Unicode MS Regular + // * VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold // // Valid font stacks for HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) // styles: @@ -13285,32 +14141,6 @@ type GetPlaceInput struct { // 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 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. - // // PlaceId is a required field PlaceId *string `location:"uri" locationName:"PlaceId" type:"string" required:"true"` } @@ -13415,6 +14245,74 @@ func (s *GetPlaceOutput) SetPlace(v *Place) *GetPlaceOutput { return s } +// The inferred state of the device, given the provided position, IP address, +// cellular signals, and Wi-Fi- access points. +type InferredState struct { + _ struct{} `type:"structure"` + + // The level of certainty of the inferred position. + Accuracy *PositionalAccuracy `type:"structure"` + + // The distance between the inferred position and the device's self-reported + // position. + DeviationDistance *float64 `type:"double"` + + // The device position inferred by the provided position, IP address, cellular + // signals, and Wi-Fi- access points. + // + // Position is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by InferredState's + // String and GoString methods. + Position []*float64 `min:"2" type:"list" sensitive:"true"` + + // Indicates if a proxy was used. + // + // ProxyDetected is a required field + ProxyDetected *bool `type:"boolean" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferredState) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferredState) GoString() string { + return s.String() +} + +// SetAccuracy sets the Accuracy field's value. +func (s *InferredState) SetAccuracy(v *PositionalAccuracy) *InferredState { + s.Accuracy = v + return s +} + +// SetDeviationDistance sets the DeviationDistance field's value. +func (s *InferredState) SetDeviationDistance(v float64) *InferredState { + s.DeviationDistance = &v + return s +} + +// SetPosition sets the Position field's value. +func (s *InferredState) SetPosition(v []*float64) *InferredState { + s.Position = v + return s +} + +// SetProxyDetected sets the ProxyDetected field's value. +func (s *InferredState) SetProxyDetected(v bool) *InferredState { + s.ProxyDetected = &v + return s +} + // The request has failed to process because of an unknown server error, exception, // or failure. type InternalServerException struct { @@ -13969,6 +14867,9 @@ func (s *ListGeofenceCollectionsOutput) SetNextToken(v string) *ListGeofenceColl } // Contains the geofence collection details. +// +// The returned geometry will always match the geometry format used when the +// geofence was created. type ListGeofenceCollectionsResponseEntry struct { _ struct{} `type:"structure"` @@ -14060,6 +14961,9 @@ func (s *ListGeofenceCollectionsResponseEntry) SetUpdateTime(v time.Time) *ListG } // 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. type ListGeofenceResponseEntry struct { _ struct{} `type:"structure"` @@ -15458,7 +16362,316 @@ type ListTrackersResponseEntry struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTrackersResponseEntry) String() string { +func (s ListTrackersResponseEntry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTrackersResponseEntry) GoString() string { + return s.String() +} + +// SetCreateTime sets the CreateTime field's value. +func (s *ListTrackersResponseEntry) SetCreateTime(v time.Time) *ListTrackersResponseEntry { + s.CreateTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ListTrackersResponseEntry) SetDescription(v string) *ListTrackersResponseEntry { + s.Description = &v + return s +} + +// SetPricingPlan sets the PricingPlan field's value. +func (s *ListTrackersResponseEntry) SetPricingPlan(v string) *ListTrackersResponseEntry { + s.PricingPlan = &v + return s +} + +// SetPricingPlanDataSource sets the PricingPlanDataSource field's value. +func (s *ListTrackersResponseEntry) SetPricingPlanDataSource(v string) *ListTrackersResponseEntry { + s.PricingPlanDataSource = &v + return s +} + +// SetTrackerName sets the TrackerName field's value. +func (s *ListTrackersResponseEntry) SetTrackerName(v string) *ListTrackersResponseEntry { + s.TrackerName = &v + return s +} + +// SetUpdateTime sets the UpdateTime field's value. +func (s *ListTrackersResponseEntry) SetUpdateTime(v time.Time) *ListTrackersResponseEntry { + s.UpdateTime = &v + return s +} + +// Details about the Long-Term Evolution (LTE) network. +type LteCellDetails struct { + _ struct{} `type:"structure"` + + // The E-UTRAN Cell Identifier (ECI). + // + // CellId is a required field + CellId *int64 `type:"integer" required:"true"` + + // The LTE local identification information (local ID). + LocalId *LteLocalId `type:"structure"` + + // The Mobile Country Code (MCC). + // + // Mcc is a required field + Mcc *int64 `min:"200" type:"integer" required:"true"` + + // The Mobile Network Code (MNC) + // + // Mnc is a required field + Mnc *int64 `type:"integer" required:"true"` + + // The network measurements. + NetworkMeasurements []*LteNetworkMeasurements `min:"1" type:"list"` + + // Indicates whether the LTE object is capable of supporting NR (new radio). + NrCapable *bool `type:"boolean"` + + // Signal power of the reference signal received, measured in decibel-milliwatts + // (dBm). + Rsrp *int64 `type:"integer"` + + // Signal quality of the reference Signal received, measured in decibels (dB). + Rsrq *float64 `type:"float"` + + // LTE Tracking Area Code (TAC). + Tac *int64 `type:"integer"` + + // Timing Advance (TA). + TimingAdvance *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LteCellDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LteCellDetails) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LteCellDetails) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LteCellDetails"} + if s.CellId == nil { + invalidParams.Add(request.NewErrParamRequired("CellId")) + } + if s.Mcc == nil { + invalidParams.Add(request.NewErrParamRequired("Mcc")) + } + if s.Mcc != nil && *s.Mcc < 200 { + invalidParams.Add(request.NewErrParamMinValue("Mcc", 200)) + } + if s.Mnc == nil { + invalidParams.Add(request.NewErrParamRequired("Mnc")) + } + if s.NetworkMeasurements != nil && len(s.NetworkMeasurements) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NetworkMeasurements", 1)) + } + if s.Rsrp != nil && *s.Rsrp < -140 { + invalidParams.Add(request.NewErrParamMinValue("Rsrp", -140)) + } + if s.Rsrq != nil && *s.Rsrq < -19.5 { + invalidParams.Add(request.NewErrParamMinValue("Rsrq", -19.5)) + } + if s.LocalId != nil { + if err := s.LocalId.Validate(); err != nil { + invalidParams.AddNested("LocalId", err.(request.ErrInvalidParams)) + } + } + if s.NetworkMeasurements != nil { + for i, v := range s.NetworkMeasurements { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "NetworkMeasurements", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCellId sets the CellId field's value. +func (s *LteCellDetails) SetCellId(v int64) *LteCellDetails { + s.CellId = &v + return s +} + +// SetLocalId sets the LocalId field's value. +func (s *LteCellDetails) SetLocalId(v *LteLocalId) *LteCellDetails { + s.LocalId = v + return s +} + +// SetMcc sets the Mcc field's value. +func (s *LteCellDetails) SetMcc(v int64) *LteCellDetails { + s.Mcc = &v + return s +} + +// SetMnc sets the Mnc field's value. +func (s *LteCellDetails) SetMnc(v int64) *LteCellDetails { + s.Mnc = &v + return s +} + +// SetNetworkMeasurements sets the NetworkMeasurements field's value. +func (s *LteCellDetails) SetNetworkMeasurements(v []*LteNetworkMeasurements) *LteCellDetails { + s.NetworkMeasurements = v + return s +} + +// SetNrCapable sets the NrCapable field's value. +func (s *LteCellDetails) SetNrCapable(v bool) *LteCellDetails { + s.NrCapable = &v + return s +} + +// SetRsrp sets the Rsrp field's value. +func (s *LteCellDetails) SetRsrp(v int64) *LteCellDetails { + s.Rsrp = &v + return s +} + +// SetRsrq sets the Rsrq field's value. +func (s *LteCellDetails) SetRsrq(v float64) *LteCellDetails { + s.Rsrq = &v + return s +} + +// SetTac sets the Tac field's value. +func (s *LteCellDetails) SetTac(v int64) *LteCellDetails { + s.Tac = &v + return s +} + +// SetTimingAdvance sets the TimingAdvance field's value. +func (s *LteCellDetails) SetTimingAdvance(v int64) *LteCellDetails { + s.TimingAdvance = &v + return s +} + +// LTE local identification information (local ID). +type LteLocalId struct { + _ struct{} `type:"structure"` + + // E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency + // channel number (EARFCN). + // + // Earfcn is a required field + Earfcn *int64 `type:"integer" required:"true"` + + // Physical Cell ID (PCI). + // + // Pci is a required field + Pci *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LteLocalId) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LteLocalId) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LteLocalId) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LteLocalId"} + if s.Earfcn == nil { + invalidParams.Add(request.NewErrParamRequired("Earfcn")) + } + if s.Pci == nil { + invalidParams.Add(request.NewErrParamRequired("Pci")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEarfcn sets the Earfcn field's value. +func (s *LteLocalId) SetEarfcn(v int64) *LteLocalId { + s.Earfcn = &v + return s +} + +// SetPci sets the Pci field's value. +func (s *LteLocalId) SetPci(v int64) *LteLocalId { + s.Pci = &v + return s +} + +// LTE network measurements. +type LteNetworkMeasurements struct { + _ struct{} `type:"structure"` + + // E-UTRAN Cell Identifier (ECI). + // + // CellId is a required field + CellId *int64 `type:"integer" required:"true"` + + // E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency + // channel number (EARFCN). + // + // Earfcn is a required field + Earfcn *int64 `type:"integer" required:"true"` + + // Physical Cell ID (PCI). + // + // Pci is a required field + Pci *int64 `type:"integer" required:"true"` + + // Signal power of the reference signal received, measured in dBm (decibel-milliwatts). + Rsrp *int64 `type:"integer"` + + // Signal quality of the reference Signal received, measured in decibels (dB). + Rsrq *float64 `type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LteNetworkMeasurements) String() string { return awsutil.Prettify(s) } @@ -15467,43 +16680,62 @@ func (s ListTrackersResponseEntry) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTrackersResponseEntry) GoString() string { +func (s LteNetworkMeasurements) GoString() string { return s.String() } -// SetCreateTime sets the CreateTime field's value. -func (s *ListTrackersResponseEntry) SetCreateTime(v time.Time) *ListTrackersResponseEntry { - s.CreateTime = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *LteNetworkMeasurements) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LteNetworkMeasurements"} + if s.CellId == nil { + invalidParams.Add(request.NewErrParamRequired("CellId")) + } + if s.Earfcn == nil { + invalidParams.Add(request.NewErrParamRequired("Earfcn")) + } + if s.Pci == nil { + invalidParams.Add(request.NewErrParamRequired("Pci")) + } + if s.Rsrp != nil && *s.Rsrp < -140 { + invalidParams.Add(request.NewErrParamMinValue("Rsrp", -140)) + } + if s.Rsrq != nil && *s.Rsrq < -19.5 { + invalidParams.Add(request.NewErrParamMinValue("Rsrq", -19.5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDescription sets the Description field's value. -func (s *ListTrackersResponseEntry) SetDescription(v string) *ListTrackersResponseEntry { - s.Description = &v +// SetCellId sets the CellId field's value. +func (s *LteNetworkMeasurements) SetCellId(v int64) *LteNetworkMeasurements { + s.CellId = &v return s } -// SetPricingPlan sets the PricingPlan field's value. -func (s *ListTrackersResponseEntry) SetPricingPlan(v string) *ListTrackersResponseEntry { - s.PricingPlan = &v +// SetEarfcn sets the Earfcn field's value. +func (s *LteNetworkMeasurements) SetEarfcn(v int64) *LteNetworkMeasurements { + s.Earfcn = &v return s } -// SetPricingPlanDataSource sets the PricingPlanDataSource field's value. -func (s *ListTrackersResponseEntry) SetPricingPlanDataSource(v string) *ListTrackersResponseEntry { - s.PricingPlanDataSource = &v +// SetPci sets the Pci field's value. +func (s *LteNetworkMeasurements) SetPci(v int64) *LteNetworkMeasurements { + s.Pci = &v return s } -// SetTrackerName sets the TrackerName field's value. -func (s *ListTrackersResponseEntry) SetTrackerName(v string) *ListTrackersResponseEntry { - s.TrackerName = &v +// SetRsrp sets the Rsrp field's value. +func (s *LteNetworkMeasurements) SetRsrp(v int64) *LteNetworkMeasurements { + s.Rsrp = &v return s } -// SetUpdateTime sets the UpdateTime field's value. -func (s *ListTrackersResponseEntry) SetUpdateTime(v time.Time) *ListTrackersResponseEntry { - s.UpdateTime = &v +// SetRsrq sets the Rsrq field's value. +func (s *LteNetworkMeasurements) SetRsrq(v float64) *LteNetworkMeasurements { + s.Rsrq = &v return s } @@ -15515,8 +16747,8 @@ type MapConfiguration struct { // custom layer, or, for styles that support custom layers, you can enable layer(s), // such as POI layer for the VectorEsriNavigation style. Default is unset. // - // Currenlty only VectorEsriNavigation supports CustomLayers. For more information, - // see Custom Layers (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers). + // Not all map resources or styles support custom layers. See Custom Layers + // for more information. CustomLayers []*string `type:"list"` // Specifies the political view for the style. Leave unset to not use a political @@ -15534,12 +16766,10 @@ type MapConfiguration struct { // // Valid Esri map styles (https://docs.aws.amazon.com/location/latest/developerguide/esri.html): // - // * 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. + // * 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 @@ -15558,17 +16788,27 @@ type MapConfiguration struct { // 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. + // * VectorEsriNavigation – The Esri Navigation map style, which provides + // a detailed basemap for the world symbolized with a custom navigation map + // style that's designed for use during the day in mobile devices. // // Valid HERE Technologies map styles (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html): // + // * VectorHereContrast – The HERE Contrast (Berlin) map style is a high + // contrast detailed base map of the world that blends 3D and 2D rendering. + // The VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin + // has been deprecated, but will continue to work in applications that use + // it. + // // * VectorHereExplore – A default HERE map style containing a neutral, // global map and its features including roads, buildings, landmarks, and // water features. It also now includes a fully designed map of Japan. // + // * VectorHereExploreTruck – A global map containing truck restrictions + // and attributes (e.g. width / height / HAZMAT) symbolized with highlighted + // segments and icons on top of HERE Explore to support use cases within + // transport and logistics. + // // * RasterHereExploreSatellite – A global map containing high resolution // satellite imagery. // @@ -15580,17 +16820,6 @@ type MapConfiguration struct { // more tiles are retrieved than when using either vector or raster tiles // alone. Your charges will include all 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. - // The 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. - // // Valid GrabMaps map styles (https://docs.aws.amazon.com/location/latest/developerguide/grab.html): // // * VectorGrabStandardLight – The Grab Standard Light map style provides @@ -15693,8 +16922,8 @@ type MapConfigurationUpdate struct { // custom layer, or, for styles that support custom layers, you can enable layer(s), // such as POI layer for the VectorEsriNavigation style. Default is unset. // - // Currenlty only VectorEsriNavigation supports CustomLayers. For more information, - // see Custom Layers (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers). + // Not all map resources or styles support custom layers. See Custom Layers + // for more information. CustomLayers []*string `type:"list"` // Specifies the political view for the style. Set to an empty string to not @@ -15800,11 +17029,8 @@ type Place struct { // An area that's part of a larger municipality. For example, Blissville is // a submunicipality in the Queen County in New York. // - // This property is only returned for a place index that uses Esri as a data - // provider. The property is represented as a district. - // - // For more information about data providers, see Amazon Location Service data - // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // This property supported by Esri and OpenData. The Esri property is district, + // and the OpenData property is borough. SubMunicipality *string `type:"string"` // A county, or an area that's part of a larger region. For example, Metro Vancouver. @@ -15821,14 +17047,13 @@ type Place struct { // For addresses with multiple units, the unit identifier. Can include numbers // and letters, for example 3B or Unit 123. // - // This property is returned only for a place index that uses Esri or Grab as - // a data provider. It is not returned for SearchPlaceIndexForPosition. + // Returned only for a place index that uses Esri or Grab as a data provider. + // Is not returned for SearchPlaceIndexForPosition. UnitNumber *string `type:"string"` // For addresses with a UnitNumber, the type of unit. For example, Apartment. // - // This property is returned only for a place index that uses Esri as a data - // provider. + // Returned only for a place index that uses Esri as a data provider. UnitType *string `type:"string"` } @@ -16065,11 +17290,13 @@ type PutGeofenceInput struct { // String and GoString methods. GeofenceProperties map[string]*string `type:"map" sensitive:"true"` - // 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. + // 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. // - // Each geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) - // can have a maximum of 1,000 vertices. + // The geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // format supports a maximum of 1,000 vertices. The Geofence Geobuf (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // format supports a maximum of 100,000 vertices. // // Geometry is a required field Geometry *GeofenceGeometry `type:"structure" required:"true"` @@ -16466,32 +17693,6 @@ type SearchForSuggestionsResult struct { // // For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by // place indexes that use Esri, Grab, or HERE as data providers. - // - // 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 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. PlaceId *string `type:"string"` // Categories from the data provider that describe the Place that are not mapped @@ -19357,6 +20558,234 @@ func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { return s } +type VerifyDevicePositionInput struct { + _ struct{} `type:"structure"` + + // The device's state, including position, IP address, cell signals and Wi-Fi + // access points. + // + // DeviceState is a required field + DeviceState *DeviceState `type:"structure" required:"true"` + + // The distance unit for the verification request. + // + // Default Value: Kilometers + DistanceUnit *string `type:"string" enum:"DistanceUnit"` + + // The name of the tracker resource to be associated with verification request. + // + // TrackerName is a required field + TrackerName *string `location:"uri" locationName:"TrackerName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VerifyDevicePositionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VerifyDevicePositionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *VerifyDevicePositionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "VerifyDevicePositionInput"} + if s.DeviceState == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceState")) + } + if s.TrackerName == nil { + invalidParams.Add(request.NewErrParamRequired("TrackerName")) + } + if s.TrackerName != nil && len(*s.TrackerName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TrackerName", 1)) + } + if s.DeviceState != nil { + if err := s.DeviceState.Validate(); err != nil { + invalidParams.AddNested("DeviceState", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceState sets the DeviceState field's value. +func (s *VerifyDevicePositionInput) SetDeviceState(v *DeviceState) *VerifyDevicePositionInput { + s.DeviceState = v + return s +} + +// SetDistanceUnit sets the DistanceUnit field's value. +func (s *VerifyDevicePositionInput) SetDistanceUnit(v string) *VerifyDevicePositionInput { + s.DistanceUnit = &v + return s +} + +// SetTrackerName sets the TrackerName field's value. +func (s *VerifyDevicePositionInput) SetTrackerName(v string) *VerifyDevicePositionInput { + s.TrackerName = &v + return s +} + +type VerifyDevicePositionOutput struct { + _ struct{} `type:"structure"` + + // The device identifier. + // + // DeviceId is a required field + DeviceId *string `min:"1" type:"string" required:"true"` + + // The distance unit for the verification response. + // + // DistanceUnit is a required field + DistanceUnit *string `type:"string" required:"true" enum:"DistanceUnit"` + + // The inferred state of the device, given the provided position, IP address, + // cellular signals, and Wi-Fi- access points. + // + // InferredState is a required field + InferredState *InferredState `type:"structure" required:"true"` + + // The timestamp for when the tracker resource received the device position + // in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // YYYY-MM-DDThh:mm:ss.sssZ. + // + // ReceivedTime is a required field + ReceivedTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` + + // The timestamp at which the device's position was determined. Uses ISO 8601 + // (https://www.iso.org/iso-8601-date-and-time-format.html) format: YYYY-MM-DDThh:mm:ss.sssZ. + // + // SampleTime is a required field + SampleTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VerifyDevicePositionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VerifyDevicePositionOutput) GoString() string { + return s.String() +} + +// SetDeviceId sets the DeviceId field's value. +func (s *VerifyDevicePositionOutput) SetDeviceId(v string) *VerifyDevicePositionOutput { + s.DeviceId = &v + return s +} + +// SetDistanceUnit sets the DistanceUnit field's value. +func (s *VerifyDevicePositionOutput) SetDistanceUnit(v string) *VerifyDevicePositionOutput { + s.DistanceUnit = &v + return s +} + +// SetInferredState sets the InferredState field's value. +func (s *VerifyDevicePositionOutput) SetInferredState(v *InferredState) *VerifyDevicePositionOutput { + s.InferredState = v + return s +} + +// SetReceivedTime sets the ReceivedTime field's value. +func (s *VerifyDevicePositionOutput) SetReceivedTime(v time.Time) *VerifyDevicePositionOutput { + s.ReceivedTime = &v + return s +} + +// SetSampleTime sets the SampleTime field's value. +func (s *VerifyDevicePositionOutput) SetSampleTime(v time.Time) *VerifyDevicePositionOutput { + s.SampleTime = &v + return s +} + +// Wi-Fi access point. +type WiFiAccessPoint struct { + _ struct{} `type:"structure"` + + // Medium access control address (Mac). + // + // MacAddress is a required field + MacAddress *string `min:"12" type:"string" required:"true"` + + // Received signal strength (dBm) of the WLAN measurement data. + // + // Rss is a required field + Rss *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WiFiAccessPoint) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WiFiAccessPoint) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *WiFiAccessPoint) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WiFiAccessPoint"} + if s.MacAddress == nil { + invalidParams.Add(request.NewErrParamRequired("MacAddress")) + } + if s.MacAddress != nil && len(*s.MacAddress) < 12 { + invalidParams.Add(request.NewErrParamMinLen("MacAddress", 12)) + } + if s.Rss == nil { + invalidParams.Add(request.NewErrParamRequired("Rss")) + } + if s.Rss != nil && *s.Rss < -128 { + invalidParams.Add(request.NewErrParamMinValue("Rss", -128)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMacAddress sets the MacAddress field's value. +func (s *WiFiAccessPoint) SetMacAddress(v string) *WiFiAccessPoint { + s.MacAddress = &v + return s +} + +// SetRss sets the Rss field's value. +func (s *WiFiAccessPoint) SetRss(v int64) *WiFiAccessPoint { + s.Rss = &v + return s +} + const ( // BatchItemErrorCodeAccessDeniedError is a BatchItemErrorCode enum value BatchItemErrorCodeAccessDeniedError = "AccessDeniedError" @@ -19421,6 +20850,26 @@ func DistanceUnit_Values() []string { } } +const ( + // ForecastedGeofenceEventTypeEnter is a ForecastedGeofenceEventType enum value + ForecastedGeofenceEventTypeEnter = "ENTER" + + // ForecastedGeofenceEventTypeExit is a ForecastedGeofenceEventType enum value + ForecastedGeofenceEventTypeExit = "EXIT" + + // ForecastedGeofenceEventTypeIdle is a ForecastedGeofenceEventType enum value + ForecastedGeofenceEventTypeIdle = "IDLE" +) + +// ForecastedGeofenceEventType_Values returns all elements of the ForecastedGeofenceEventType enum +func ForecastedGeofenceEventType_Values() []string { + return []string{ + ForecastedGeofenceEventTypeEnter, + ForecastedGeofenceEventTypeExit, + ForecastedGeofenceEventTypeIdle, + } +} + const ( // IntendedUseSingleUse is a IntendedUse enum value IntendedUseSingleUse = "SingleUse" @@ -19525,6 +20974,22 @@ func RouteMatrixErrorCode_Values() []string { } } +const ( + // SpeedUnitKilometersPerHour is a SpeedUnit enum value + SpeedUnitKilometersPerHour = "KilometersPerHour" + + // SpeedUnitMilesPerHour is a SpeedUnit enum value + SpeedUnitMilesPerHour = "MilesPerHour" +) + +// SpeedUnit_Values returns all elements of the SpeedUnit enum +func SpeedUnit_Values() []string { + return []string{ + SpeedUnitKilometersPerHour, + SpeedUnitMilesPerHour, + } +} + const ( // StatusActive is a Status enum value StatusActive = "Active" diff --git a/service/locationservice/locationserviceiface/interface.go b/service/locationservice/locationserviceiface/interface.go index a7fff7a9ae9..b1ce271d091 100644 --- a/service/locationservice/locationserviceiface/interface.go +++ b/service/locationservice/locationserviceiface/interface.go @@ -172,6 +172,13 @@ type LocationServiceAPI interface { DisassociateTrackerConsumerWithContext(aws.Context, *locationservice.DisassociateTrackerConsumerInput, ...request.Option) (*locationservice.DisassociateTrackerConsumerOutput, error) DisassociateTrackerConsumerRequest(*locationservice.DisassociateTrackerConsumerInput) (*request.Request, *locationservice.DisassociateTrackerConsumerOutput) + ForecastGeofenceEvents(*locationservice.ForecastGeofenceEventsInput) (*locationservice.ForecastGeofenceEventsOutput, error) + ForecastGeofenceEventsWithContext(aws.Context, *locationservice.ForecastGeofenceEventsInput, ...request.Option) (*locationservice.ForecastGeofenceEventsOutput, error) + ForecastGeofenceEventsRequest(*locationservice.ForecastGeofenceEventsInput) (*request.Request, *locationservice.ForecastGeofenceEventsOutput) + + ForecastGeofenceEventsPages(*locationservice.ForecastGeofenceEventsInput, func(*locationservice.ForecastGeofenceEventsOutput, bool) bool) error + ForecastGeofenceEventsPagesWithContext(aws.Context, *locationservice.ForecastGeofenceEventsInput, func(*locationservice.ForecastGeofenceEventsOutput, bool) bool, ...request.Option) error + GetDevicePosition(*locationservice.GetDevicePositionInput) (*locationservice.GetDevicePositionOutput, error) GetDevicePositionWithContext(aws.Context, *locationservice.GetDevicePositionInput, ...request.Option) (*locationservice.GetDevicePositionOutput, error) GetDevicePositionRequest(*locationservice.GetDevicePositionInput) (*request.Request, *locationservice.GetDevicePositionOutput) @@ -321,6 +328,10 @@ type LocationServiceAPI interface { UpdateTracker(*locationservice.UpdateTrackerInput) (*locationservice.UpdateTrackerOutput, error) UpdateTrackerWithContext(aws.Context, *locationservice.UpdateTrackerInput, ...request.Option) (*locationservice.UpdateTrackerOutput, error) UpdateTrackerRequest(*locationservice.UpdateTrackerInput) (*request.Request, *locationservice.UpdateTrackerOutput) + + VerifyDevicePosition(*locationservice.VerifyDevicePositionInput) (*locationservice.VerifyDevicePositionOutput, error) + VerifyDevicePositionWithContext(aws.Context, *locationservice.VerifyDevicePositionInput, ...request.Option) (*locationservice.VerifyDevicePositionOutput, error) + VerifyDevicePositionRequest(*locationservice.VerifyDevicePositionInput) (*request.Request, *locationservice.VerifyDevicePositionOutput) } var _ LocationServiceAPI = (*locationservice.LocationService)(nil) diff --git a/service/sns/api.go b/service/sns/api.go index 36e14883e62..8db93d6e9c1 100644 --- a/service/sns/api.go +++ b/service/sns/api.go @@ -359,15 +359,15 @@ func (c *SNS) CreatePlatformApplicationRequest(input *CreatePlatformApplicationI // - For ADM, PlatformPrincipal is client id and PlatformCredential is client // secret. // -// - For Baidu, PlatformPrincipal is API key and PlatformCredential is secret -// key. -// // - For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal // is SSL certificate and PlatformCredential is private key. // // - For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal // is signing key ID and PlatformCredential is signing key. // +// - For Baidu, PlatformPrincipal is API key and PlatformCredential is secret +// key. +// // - For GCM (Firebase Cloud Messaging) using key credentials, there is no // PlatformPrincipal. The PlatformCredential is API key. // @@ -5418,7 +5418,7 @@ type CreateTopicInput struct { // A map of attributes with their corresponding values. // - // The following lists the names, descriptions, and values of the special request + // The following lists names, descriptions, and values of the special request // parameters that the CreateTopic action uses: // // * DeliveryPolicy – The policy that defines how Amazon SNS retries failed @@ -6412,15 +6412,14 @@ type GetSubscriptionAttributesOutput struct { // // * TopicArn – The topic ARN that the subscription is associated with. // - // The following attribute applies only to Amazon Kinesis Data Firehose delivery - // stream subscriptions: + // The following attribute applies only to Amazon Data Firehose delivery stream + // subscriptions: // // * SubscriptionRoleArn – The ARN of the IAM role that has the following: - // 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 - // (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) + // 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 (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) // in the Amazon SNS Developer Guide. Attributes map[string]*string `type:"map"` } @@ -8099,9 +8098,8 @@ type PublishInput struct { // 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. + // Constraints: Subjects must be UTF-8 text with no line breaks or control characters, + // and less than 100 characters long. Subject *string `type:"string"` // If you don't specify a value for the TargetArn parameter, you must specify @@ -8889,15 +8887,14 @@ type SetSubscriptionAttributesInput struct { // endpoint becomes unavailable) are held in the dead-letter queue for further // analysis or reprocessing. // - // The following attribute applies only to Amazon Kinesis Data Firehose delivery - // stream subscriptions: + // The following attribute applies only to Amazon Data Firehose delivery stream + // subscriptions: // // * SubscriptionRoleArn – The ARN of the IAM role that has the following: - // 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 - // (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) + // 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 (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) // in the Amazon SNS Developer Guide. // // AttributeName is a required field @@ -9211,15 +9208,14 @@ type SubscribeInput struct { // endpoint becomes unavailable) are held in the dead-letter queue for further // analysis or reprocessing. // - // The following attribute applies only to Amazon Kinesis Data Firehose delivery - // stream subscriptions: + // The following attribute applies only to Amazon Data Firehose delivery stream + // subscriptions: // // * SubscriptionRoleArn – The ARN of the IAM role that has the following: - // 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 - // (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) + // 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 (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) // in the Amazon SNS Developer Guide. // // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): diff --git a/service/sqs/api.go b/service/sqs/api.go index 1ce22565ae3..873e1309e67 100644 --- a/service/sqs/api.go +++ b/service/sqs/api.go @@ -2322,12 +2322,15 @@ func (c *SQS) SendMessageRequest(input *SendMessageInput) (req *request.Request, // Delivers a message to the specified queue. // // A message can include only XML, JSON, and unformatted text. The following -// Unicode characters are allowed: +// Unicode characters are allowed. For more information, see the W3C specification +// for characters (http://www.w3.org/TR/REC-xml/#charsets). // // #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF // -// Any characters not included in this list will be rejected. For more information, -// see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets). +// Amazon SQS does not throw an exception or completely reject the message if +// it contains invalid characters. Instead, it replaces those invalid characters +// with U+FFFD before storing the message in the queue, as long as the message +// body contains at least one valid character. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2478,12 +2481,15 @@ func (c *SQS) SendMessageBatchRequest(input *SendMessageBatchInput) (req *reques // both 256 KiB (262,144 bytes). // // A message can include only XML, JSON, and unformatted text. The following -// Unicode characters are allowed: +// Unicode characters are allowed. For more information, see the W3C specification +// for characters (http://www.w3.org/TR/REC-xml/#charsets). // // #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF // -// Any characters not included in this list will be rejected. For more information, -// see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets). +// Amazon SQS does not throw an exception or completely reject the message if +// it contains invalid characters. Instead, it replaces those invalid characters +// with U+FFFD before storing the message in the queue, as long as the message +// body contains at least one valid character. // // If you don't specify the DelaySeconds parameter for an entry, Amazon SQS // uses the default value for the queue. @@ -8294,12 +8300,15 @@ type SendMessageInput struct { // is 256 KiB. // // A message can include only XML, JSON, and unformatted text. The following - // Unicode characters are allowed: + // Unicode characters are allowed. For more information, see the W3C specification + // for characters (http://www.w3.org/TR/REC-xml/#charsets). // // #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF // - // Any characters not included in this list will be rejected. For more information, - // see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets). + // Amazon SQS does not throw an exception or completely reject the message if + // it contains invalid characters. Instead, it replaces those invalid characters + // with U+FFFD before storing the message in the queue, as long as the message + // body contains at least one valid character. // // MessageBody is a required field MessageBody *string `type:"string" required:"true"` diff --git a/service/storagegateway/api.go b/service/storagegateway/api.go index e522c51d086..24baf7b6cb1 100644 --- a/service/storagegateway/api.go +++ b/service/storagegateway/api.go @@ -3440,8 +3440,10 @@ func (c *StorageGateway) DescribeMaintenanceStartTimeRequest(input *DescribeMain // DescribeMaintenanceStartTime API operation for AWS Storage Gateway. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7970,9 +7972,9 @@ func (c *StorageGateway) UpdateGatewayInformationRequest(input *UpdateGatewayInf // UpdateGatewayInformation API operation for AWS Storage Gateway. // -// 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. +// 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 @@ -8158,9 +8160,20 @@ func (c *StorageGateway) UpdateMaintenanceStartTimeRequest(input *UpdateMaintena // UpdateMaintenanceStartTime API operation for AWS Storage Gateway. // -// 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 MinuteOfHour +// and HourOfDay, and either DayOfMonth or DayOfWeek. +// +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8613,12 +8626,14 @@ func (c *StorageGateway) UpdateSMBSecurityStrategyRequest(input *UpdateSMBSecuri // UpdateSMBSecurityStrategy API operation for AWS Storage Gateway. // -// Updates the SMB security strategy on a file gateway. This action is only -// supported in file gateways. +// Updates the SMB security strategy level for an Amazon S3 file gateway. This +// action is only supported for Amazon S3 file gateways. // -// This API is called Security level in the User Guide. +// For information about configuring this setting using the Amazon Web Services +// console, see Setting a security level for your gateway (https://docs.aws.amazon.com/filegateway/latest/files3/security-strategy.html) +// in the Amazon S3 File Gateway User Guide. // -// A higher security level can affect performance of the gateway. +// A higher security strategy level can affect performance of the gateway. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -15035,6 +15050,8 @@ func (s *DescribeMaintenanceStartTimeInput) SetGatewayARN(v string) *DescribeMai // A JSON object containing the following fields: // +// - DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences +// // - DescribeMaintenanceStartTimeOutput$DayOfMonth // // - DescribeMaintenanceStartTimeOutput$DayOfWeek @@ -15049,7 +15066,8 @@ type DescribeMaintenanceStartTimeOutput struct { // 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. + // month. It is not possible to set the maintenance schedule to start on days + // 29 through 31. DayOfMonth *int64 `min:"1" type:"integer"` // An ordinal number between 0 and 6 that represents the day of the week, where @@ -15071,6 +15089,15 @@ type DescribeMaintenanceStartTimeOutput struct { // the gateway. MinuteOfHour *int64 `type:"integer"` + // A set of variables indicating the software update preferences for the gateway. + // + // Includes AutomaticUpdatePolicy field with the following inputs: + // + // ALL_VERSIONS - Enables regular gateway maintenance updates. + // + // EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. + SoftwareUpdatePreferences *SoftwareUpdatePreferences `type:"structure"` + // 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. Timezone *string `min:"3" type:"string"` @@ -15124,6 +15151,12 @@ func (s *DescribeMaintenanceStartTimeOutput) SetMinuteOfHour(v int64) *DescribeM return s } +// SetSoftwareUpdatePreferences sets the SoftwareUpdatePreferences field's value. +func (s *DescribeMaintenanceStartTimeOutput) SetSoftwareUpdatePreferences(v *SoftwareUpdatePreferences) *DescribeMaintenanceStartTimeOutput { + s.SoftwareUpdatePreferences = v + return s +} + // SetTimezone sets the Timezone field's value. func (s *DescribeMaintenanceStartTimeOutput) SetTimezone(v string) *DescribeMaintenanceStartTimeOutput { s.Timezone = &v @@ -15399,21 +15432,22 @@ type DescribeSMBSettingsOutput struct { // 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. + // * 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 use this option, File Gateway only allows + // * 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. // - // * 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. + // * 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. SMBSecurityStrategy *string `type:"string" enum:"SMBSecurityStrategy"` } @@ -20931,6 +20965,42 @@ func (s *ShutdownGatewayOutput) SetGatewayARN(v string) *ShutdownGatewayOutput { return s } +// A set of variables indicating the software update preferences for the gateway. +type SoftwareUpdatePreferences struct { + _ struct{} `type:"structure"` + + // Indicates the automatic update policy for a gateway. + // + // ALL_VERSIONS - Enables regular gateway maintenance updates. + // + // EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. + AutomaticUpdatePolicy *string `type:"string" enum:"AutomaticUpdatePolicy"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SoftwareUpdatePreferences) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SoftwareUpdatePreferences) GoString() string { + return s.String() +} + +// SetAutomaticUpdatePolicy sets the AutomaticUpdatePolicy field's value. +func (s *SoftwareUpdatePreferences) SetAutomaticUpdatePolicy(v string) *SoftwareUpdatePreferences { + s.AutomaticUpdatePolicy = &v + return s +} + type StartAvailabilityMonitorTestInput struct { _ struct{} `type:"structure"` @@ -22460,7 +22530,10 @@ type UpdateGatewayInformationInput struct { // GatewayARN is a required field GatewayARN *string `min:"50" type:"string" required:"true"` - // 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 (https://docs.aws.amazon.com/filegateway/latest/files3/performance-multiple-file-shares.html) + // in the Amazon S3 File Gateway User Guide. GatewayCapacity *string `type:"string" enum:"GatewayCapacity"` // The name you configured for your gateway. @@ -22671,6 +22744,8 @@ func (s *UpdateGatewaySoftwareNowOutput) SetGatewayARN(v string) *UpdateGatewayS // A JSON object containing the following fields: // +// - UpdateMaintenanceStartTimeInput$SoftwareUpdatePreferences +// // - UpdateMaintenanceStartTimeInput$DayOfMonth // // - UpdateMaintenanceStartTimeInput$DayOfWeek @@ -22683,11 +22758,13 @@ type UpdateMaintenanceStartTimeInput struct { // 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. + // month. It is not possible to set the maintenance schedule to start on days + // 29 through 31. DayOfMonth *int64 `min:"1" type:"integer"` // 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. + // as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents + // Saturday. DayOfWeek *int64 `type:"integer"` // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation @@ -22699,16 +22776,21 @@ type UpdateMaintenanceStartTimeInput struct { // The hour component of the maintenance start time represented as hh, where // hh is the hour (00 to 23). The hour of the day is in the time zone of the // gateway. - // - // HourOfDay is a required field - HourOfDay *int64 `type:"integer" required:"true"` + HourOfDay *int64 `type:"integer"` // The minute component of the maintenance start time represented as mm, where // mm is the minute (00 to 59). The minute of the hour is in the time zone of // the gateway. + MinuteOfHour *int64 `type:"integer"` + + // A set of variables indicating the software update preferences for the gateway. + // + // Includes AutomaticUpdatePolicy field with the following inputs: // - // MinuteOfHour is a required field - MinuteOfHour *int64 `type:"integer" required:"true"` + // ALL_VERSIONS - Enables regular gateway maintenance updates. + // + // EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. + SoftwareUpdatePreferences *SoftwareUpdatePreferences `type:"structure"` } // String returns the string representation. @@ -22741,12 +22823,6 @@ func (s *UpdateMaintenanceStartTimeInput) Validate() error { if s.GatewayARN != nil && len(*s.GatewayARN) < 50 { invalidParams.Add(request.NewErrParamMinLen("GatewayARN", 50)) } - if s.HourOfDay == nil { - invalidParams.Add(request.NewErrParamRequired("HourOfDay")) - } - if s.MinuteOfHour == nil { - invalidParams.Add(request.NewErrParamRequired("MinuteOfHour")) - } if invalidParams.Len() > 0 { return invalidParams @@ -22784,6 +22860,12 @@ func (s *UpdateMaintenanceStartTimeInput) SetMinuteOfHour(v int64) *UpdateMainte return s } +// SetSoftwareUpdatePreferences sets the SoftwareUpdatePreferences field's value. +func (s *UpdateMaintenanceStartTimeInput) SetSoftwareUpdatePreferences(v *SoftwareUpdatePreferences) *UpdateMaintenanceStartTimeInput { + s.SoftwareUpdatePreferences = v + return s +} + // A JSON object containing the Amazon Resource Name (ARN) of the gateway whose // maintenance start time is updated. type UpdateMaintenanceStartTimeOutput struct { @@ -23636,19 +23718,25 @@ type UpdateSMBSecurityStrategyInput struct { // 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. + // 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 + // 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 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. + // 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. // // SMBSecurityStrategy is a required field SMBSecurityStrategy *string `type:"string" required:"true" enum:"SMBSecurityStrategy"` @@ -24338,6 +24426,22 @@ func ActiveDirectoryStatus_Values() []string { } } +const ( + // AutomaticUpdatePolicyAllVersions is a AutomaticUpdatePolicy enum value + AutomaticUpdatePolicyAllVersions = "ALL_VERSIONS" + + // AutomaticUpdatePolicyEmergencyVersionsOnly is a AutomaticUpdatePolicy enum value + AutomaticUpdatePolicyEmergencyVersionsOnly = "EMERGENCY_VERSIONS_ONLY" +) + +// AutomaticUpdatePolicy_Values returns all elements of the AutomaticUpdatePolicy enum +func AutomaticUpdatePolicy_Values() []string { + return []string{ + AutomaticUpdatePolicyAllVersions, + AutomaticUpdatePolicyEmergencyVersionsOnly, + } +} + const ( // AvailabilityMonitorTestStatusComplete is a AvailabilityMonitorTestStatus enum value AvailabilityMonitorTestStatusComplete = "COMPLETE"