Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The name of the partner event source to activate.

[required] The name of the replay to cancel.

[required] The name for the API destination to create.

A description for the API destination to create.

[required] The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

[required] The URL to the HTTP invocation endpoint for the API destination.

[required] The method to use for the request to the HTTP invocation endpoint.

The maximum number of requests per second to send to the HTTP invocation endpoint.

[required] The name for the archive to create.

[required] The ARN of the event bus that sends events to the archive.

A description for the archive.

An event pattern to use to filter events sent to the archive.

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

[required] The name for the connection to create.

A description for the connection to create.

[required] The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

[required] The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

For more information, see Connecting to private resources in the Amazon EventBridge User Guide .

[required] The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

A description of the global endpoint.

[required] Configure the routing policy, including the health check and secondary Region..

Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

[required] Define the event buses used.

The names of the event buses must be identical in each Region.

The ARN of the role used for replication.

[required] The name of the new event bus.

Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

The event bus description.

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Managing keys in the Key Management Service Developer Guide.

Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

• You call create_archive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Tags to associate with the event bus.

[required] The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name. The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

[required] The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

[required] The name of the partner event source to deactivate.

[required] The name of the connection to remove authorization from.

[required] The name of the destination to delete.

[required] The name of the archive to delete.

[required] The name of the connection to delete.

[required] The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..

[required] The name of the event bus to delete.

[required] The name of the event source to delete.

[required] The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using describe_rule or list_rules and checking the ManagedBy field of the response.

[required] The name of the API destination to retrieve.

[required] The name of the archive to retrieve.

[required] The name of the connection to retrieve.

[required] The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".

The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

[required] The name of the partner event source to display the details of.

[required] The name of the event source to display.

[required] The name of the replay to retrieve.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

The ARN of the connection specified for the API destination.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of API destinations to include in the response.

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

The ARN of the event source associated with the archive.

The state of the archive.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of results to return.

A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

The state of the connection.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of connections to return.

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of results returned by the call.

Specifying this limits the results to only those event buses with names that start with the specified prefix.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

[required] The name of the partner event source to display account information about.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

[required] If you specify this, the results are limited to only those partner event sources that start with the string you specify.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

The state of the replay.

The ARN of the archive from which the events are replayed.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of replays to retrieve.

[required] The Amazon Resource Name (ARN) of the target resource.

The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of results to return.

The prefix matching the rule name.

The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of results to return.

[required] The ARN of the EventBridge resource for which you want to view tags.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

The maximum number of results to return.

[required] The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

When using Java, you must include auth-crt on the class path.

[required] The list of events to write to the event bus.

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

The action that you are enabling the other account to perform.

The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run remove_permission.

Each StatementId must be unique.

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.

[required] The name of the rule that you are creating or updating.

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .

The state of the rule.

Valid values include:

• DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

• ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

• ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

  Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

  This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

A description of the rule.

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

The list of key-value pairs to associate with the rule.

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

[required] The targets to update or add to the rule.

The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

Specifies whether to remove all permissions.

The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

[required] The name of the rule.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

[required] The IDs of the targets to remove from the rule.

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using describe_rule or list_rules and checking the ManagedBy field of the response.

[required] The name of the replay to start.

A description for the replay to start.

[required] The ARN of the archive to replay events from.

[required] A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

[required] A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

[required] A ReplayDestination object that includes details about the destination for the replay.

[required] The ARN of the EventBridge resource that you're adding tags to.

[required] The list of key-value pairs to associate with the resource.

[required] The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

[required] The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory:

• id

• account

• source

• time

• region

• resources

• detail-type

[required] The ARN of the EventBridge resource from which you are removing tags.

[required] The list of tag keys to remove from the resource.

[required] The name of the API destination to update.

The name of the API destination to update.

The ARN of the connection to use for the API destination.

The URL to the endpoint to use for the API destination.

The method to use for the API destination.

The maximum number of invocations per second to send to the API destination.

[required] The name of the archive to update.

The description for the archive.

The event pattern to use to filter events sent to the archive.

The number of days to retain events in the archive.

[required] The name of the connection to update.

A description for the connection.

The type of authorization to use for the connection.

The authorization parameters to use for the connection.

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

For more information, see Connecting to private resources in the Amazon EventBridge User Guide .

[required] The name of the endpoint you want to update.

A description for the endpoint.

Configure the routing policy, including the health check and secondary Region.

Whether event replication was enabled or disabled by this request.

Define event buses used for replication.

The ARN of the role used by event replication for this request.

The name of the event bus.

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Managing keys in the Key Management Service Developer Guide.

Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

• You call create_archive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

The event bus description.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The name of the pipe.

A description of the pipe.

The state the pipe should be in.

[required] The ARN of the source resource.

The parameters required to set up a source for your pipe.

The ARN of the enrichment resource.

The parameters required to set up enrichment on your pipe.

[required] The ARN of the target resource.

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

[required] The ARN of the role that allows the pipe to send data to the target.

The list of key-value pairs to associate with the pipe.

The logging configuration settings for the pipe.

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.

For more information, see Managing keys in the Key Management Service Developer Guide.

[required] The name of the pipe.

[required] The name of the pipe.

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

The state the pipe should be in.

The state the pipe is in.

The prefix matching the pipe source.

The prefix matching the pipe target.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

The maximum number of pipes to include in the response.

[required] The ARN of the pipe for which you want to view tags.

[required] The name of the pipe.

[required] The name of the pipe.

[required] The ARN of the pipe.

[required] The list of key-value pairs associated with the pipe.

[required] The ARN of the pipe.

[required] The list of tag keys to remove from the pipe.

[required] The name of the pipe.

A description of the pipe.

The state the pipe should be in.

The parameters required to set up a source for your pipe.

The ARN of the enrichment resource.

The parameters required to set up enrichment on your pipe.

The ARN of the target resource.

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

[required] The ARN of the role that allows the pipe to send data to the target.

The logging configuration settings for the pipe.

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.

To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.

For more information, see Managing keys in the Key Management Service Developer Guide.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

The description you specify for the schedule.

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

[required] Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

[required] The name of the schedule that you are creating.

[required] The expression that defines when the schedule runs. The following formats are supported.

• at expression - at(yyyy-mm-ddThh:mm:ss)

• rate expression - ⁠rate(value unit)⁠

• cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: ⁠(minutes hours day_of_month month day_of_week year)⁠.

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

The timezone in which the scheduling expression is evaluated.

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

Specifies whether the schedule is enabled or disabled.

[required] The schedule's target.

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

[required] The name of the schedule group that you are creating.

The list of tags to associate with the schedule group.

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

[required] The name of the schedule to delete.

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

[required] The name of the schedule group to delete.

The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.

[required] The name of the schedule to retrieve.

[required] The name of the schedule group to retrieve.

If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

The name prefix that you can use to return a filtered list of your schedule groups.

The token returned by a previous call to retrieve the next set of results.

If specified, only lists the schedules whose associated schedule group matches the given filter.

If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

Schedule name prefix to return the filtered list of resources.

The token returned by a previous call to retrieve the next set of results.

If specified, only lists the schedules whose current state matches the given filter.

[required] The ARN of the EventBridge Scheduler resource for which you want to view tags.

[required] The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.

[required] The list of tags to associate with the schedule group.

[required] The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.

[required] The list of tag keys to remove from the resource.

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

The description you specify for the schedule.

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

[required] Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.

The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.

[required] The name of the schedule that you are updating.

[required] The expression that defines when the schedule runs. The following formats are supported.

• at expression - at(yyyy-mm-ddThh:mm:ss)

• rate expression - ⁠rate(value unit)⁠

• cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: ⁠(minutes hours day_of_month month day_of_week year)⁠.

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

The timezone in which the scheduling expression is evaluated.

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

Specifies whether the schedule is enabled or disabled.

[required] The schedule target. You can use this operation to change the target that your schedule invokes.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The name of the tracker resource to be associated with a geofence collection.

[required] The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all Amazon Web Services.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

[required] The name of the tracker resource to delete the device position history from.

[required] Devices whose position history you want to delete.

• For example, for two devices: ⁠“DeviceIds” : [DeviceId1,DeviceId2]⁠

[required] The geofence collection storing the geofences to be deleted.

[required] The batch of geofences to be deleted.

[required] The geofence collection used in evaluating the position of devices against its geofences.

[required] Contains device details for each device to be evaluated against the given geofence collection.

[required] The tracker resource retrieving the device position.

[required] Devices whose position you want to retrieve.

• For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

[required] The geofence collection storing the geofences.

[required] The batch of geofences to be stored in a geofence collection.

[required] The name of the tracker resource to update.

[required] Contains the position update details for each device, up to 10 devices.

[required] The name of the route calculator resource that you want to use to calculate the route.

[required] The start position for the route. Defined in World Geodetic System (WGS 84) format: ⁠[longitude, latitude]⁠.

• For example, ⁠[-123.115, 49.285]⁠

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a ⁠400 RoutesValidationException⁠ error.

Valid Values: ⁠[-180 to 180,-90 to 90]⁠

[required] The finish position for the route. Defined in World Geodetic System (WGS 84) format: ⁠[longitude, latitude]⁠.

• For example, ⁠[-122.339, 47.615]⁠

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: ⁠[-180 to 180,-90 to 90]⁠

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition ⁠[-123.115, 49.285]⁠, the route follows the order that the waypoint positions are given ⁠[[-122.757, 49.0021],[-122.349, 47.620]]⁠

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a ⁠400 ValidationException⁠ error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a ⁠400 RoutesValidationException⁠ error.

Valid Values: ⁠[-180 to 180,-90 to 90]⁠

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

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⁠

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Set the unit system to specify the distance.

Default Value: Kilometers

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

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.

Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

ArrivalTime is not supported Esri.

Specifies the distance to optimize for when calculating a route.

The optional API key to authorize the request.

[required] The name of the route calculator resource that you want to use to calculate the route matrix.

[required] The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: ⁠[longitude, latitude]⁠. For example, ⁠[-123.115, 49.285]⁠.

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

Valid Values: ⁠[-180 to 180,-90 to 90]⁠

[required] The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: ⁠[longitude, latitude]⁠. For example, ⁠[-122.339, 47.615]⁠

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

Valid Values: ⁠[-180 to 180,-90 to 90]⁠

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

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⁠

Sets the time of departure as the current time. Uses the current 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.

Default Value: false

Valid Values: false | true

Set the unit system to specify the distance.

Default Value: Kilometers

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

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 optional API key to authorize the request.

[required] A custom name for the geofence collection.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique geofence collection name.

• No spaces allowed. For example, ExampleGeofenceCollection.

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

An optional description for the geofence collection.

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

[required] A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

[required] The API key restrictions for the API key resource.

An optional description for the API key resource.

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

[required] The name for the map resource.

Requirements:

• Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique map resource name.

• No spaces allowed. For example, ExampleMap.

[required] Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

An optional description for the map resource.

Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

[required] The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

[required] Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.

• Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.

  If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

No longer used. If included, the only allowed value is RequestBasedUsage.

The optional description for the place index resource.

Specifies the data storage option requesting Places.

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

[required] The name of the route calculator resource.

Requirements:

• Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).

• Must be a unique Route calculator resource name.

• No spaces allowed. For example, ExampleRouteCalculator.

[required] Specifies the data provider of traffic and road network data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.

  Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

• Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

No longer used. If included, the only allowed value is RequestBasedUsage.

The optional description for the route calculator resource.

Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

• For example: { "tag1" : "value1", "tag2" : "value2"}

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

[required] The name for the tracker resource.

Requirements:

• Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).

• Must be a unique tracker resource name.

• No spaces allowed. For example, ExampleTracker.

No longer used. If included, the only allowed value is RequestBasedUsage.

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

This parameter is no longer used.

An optional description for the tracker resource.

Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Specifies the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

This field is optional. If not specified, the default value is TimeBased.

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.

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.

[required] The name of the geofence collection to be deleted.

[required] The name of the API key to delete.

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.

[required] The name of the map resource to be deleted.

[required] The name of the place index resource to be deleted.

[required] The name of the route calculator resource to be deleted.

[required] The name of the tracker resource to be deleted.

[required] The name of the geofence collection.

[required] The name of the API key resource.

[required] The name of the map resource.

[required] The name of the place index resource.

[required] The name of the route calculator resource.

[required] The name of the tracker resource.

[required] The name of the tracker resource to be dissociated from the consumer.

[required] 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

[required] The name of the geofence collection.

[required] The device's state, including current position and speed.

Specifies the time horizon in minutes for the forecasted events.

The distance unit used for the 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 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 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

An optional limit for the number of resources returned in a single call.

Default value: 20

[required] The tracker resource receiving the position update.

[required] The device whose position you want to retrieve.

[required] The tracker resource receiving the request for the device position history.

[required] The device whose position history you want to retrieve.

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

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.

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.

An optional limit for the number of device positions returned in a single call.

Default value: 100

[required] The geofence collection storing the target geofence.

[required] The geofence you're retrieving details for.

[required] The map resource associated with the glyph file.

[required] 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⁠.

[required] A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to ⁠00FF⁠. Must be aligned to multiples of 256.

The optional API key to authorize the request.

[required] The map resource associated with the sprite file.

[required] The name of the sprite file. Use the following file names for the sprite sheet:

• sprites.png

• ⁠sprites@2x.png⁠ for high pixel density displays

For the JSON document containing image offsets. Use the following file names:

• sprites.json

• ⁠sprites@2x.json⁠ for high pixel density displays

The optional API key to authorize the request.

[required] The map resource to retrieve the style descriptor from.

The optional API key to authorize the request.

[required] The map resource to retrieve the map tiles from.

[required] The zoom value for the map tile.

[required] The X axis value for the map tile.

[required] The Y axis value for the map tile.

The optional API key to authorize the request.

[required] The name of the place index resource that you want to use for the search.

[required] The identifier of the place to find.

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as A\Theta\eta\nu\alpha.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

The optional API key to authorize the request.

[required] The tracker resource containing the requested devices.

An optional limit for the number of entries returned in a single call.

Default value: 100

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 geometry used to filter device positions.

An optional limit for the number of resources returned in a single call.

Default value: 100

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

[required] The name of the geofence collection storing the list of geofences.

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

An optional limit for the number of geofences returned in a single call.

Default value: 100

An optional limit for the number of resources returned in a single call.

Default value: 100

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

Optionally filter the list to only Active or Expired API keys.

An optional limit for the number of resources returned in a single call.

Default value: 100

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

An optional limit for the maximum number of results returned in a single call.

Default value: 100

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

An optional maximum number of results returned in a single call.

Default Value: 100

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

[required] The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

[required] The tracker resource whose associated geofence collections you want to list.

An optional limit for the number of resources returned in a single call.

Default value: 100

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

An optional limit for the number of resources returned in a single call.

Default value: 100

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

[required] The geofence collection to store the geofence in.

[required] An identifier for the geofence. For example, ExampleGeofence-1.

[required] Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

[required] The name of the place index resource you want to use for the search.

[required] Specifies the longitude and latitude of the position to query.

This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, ⁠[-123.1174, 49.2847]⁠ represents a position with longitude -123.1174 and latitude 49.2847.

An optional parameter. The maximum number of results returned per request.

Default value: 50

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as A\Theta\eta\nu\alpha.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

The optional API key to authorize the request.

[required] The name of the place index resource you want to use for the search.

[required] The free-form partial text to use to generate place suggestions. For example, ⁠eiffel tow⁠.

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, ⁠[-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.

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, ⁠[-12.7935, -37.4835, -12.0684, -36.9542]⁠ represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

An optional parameter. The maximum number of results returned per request.

The default: 5

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for ⁠Athens, Gr⁠ to get suggestions with the language parameter set to en. The results found will most likely be returned as ⁠Athens, Greece⁠.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as A\Theta\eta\nu\sigma, E\lambda\lambda\alpha\delta.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

The optional API key to authorize the request.

[required] The name of the place index resource you want to use for the search.

[required] The address, name, city, or region to be used in the search in free-form text format. For example, ⁠123 Any Street⁠.

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.

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, ⁠[-12.7935, -37.4835, -12.0684, -36.9542]⁠ represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

An optional parameter. The maximum number of results returned per request.

The default: 50

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for ⁠Athens, Greece⁠, with the language parameter set to en. The result found will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as A\Theta\eta\nu\alpha.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

The optional API key to authorize the request.

[required] The Amazon Resource Name (ARN) of the resource whose tags you want to update.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

[required] Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

[required] The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

[required] The list of tag keys to remove from the specified resource.

[required] The name of the geofence collection to update.

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

Updates the description for the geofence collection.

[required] The name of the API key resource to update.

Updates the description for the API key resource.

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

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

Updates the API key restrictions for the API key resource.

[required] The name of the map resource to update.

No longer used. If included, the only allowed value is RequestBasedUsage.

Updates the description for the map resource.

Updates the parts of the map configuration that can be updated, including the political view.

[required] The name of the place index resource to update.

No longer used. If included, the only allowed value is RequestBasedUsage.

Updates the description for the place index resource.

Updates the data storage option for the place index resource.

[required] The name of the route calculator resource to update.

No longer used. If included, the only allowed value is RequestBasedUsage.

Updates the description for the route calculator resource.

[required] The name of the tracker resource to update.

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

Updates the description for the tracker resource.

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

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.

[required] The name of the tracker resource to be associated with verification request.

[required] The device's state, including position, IP address, cell signals and Wi-Fi access points.

The distance unit for the verification request.

Default Value: Kilometers

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

[required] Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.

A list of information about the configuration.

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.

We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.

[required] Required. The broker's deployment mode.

Encryption options for the broker.

[required] Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

[required] Required. The broker's instance type.

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Enables Amazon CloudWatch logging for brokers.

The parameters that determine the WeeklyStartTime.

[required] Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

The broker's storage type.

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.

Create tags when creating the broker.

[required] The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

Defines whether this broker is a part of a data replication pair.

The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

[required] Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

[required] Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

Create tags when creating the configuration.

[required] The Amazon Resource Name (ARN) of the resource tag.

The key-value pair for the resource tag.

[required] The unique ID that Amazon MQ generates for the broker.

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

[required] Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

[required] The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Defines if this user is intended for CRDR replication purposes.

[required] The unique ID that Amazon MQ generates for the broker.

[required] The Amazon Resource Name (ARN) of the resource tag.

[required] An array of tag keys to delete

[required] The unique ID that Amazon MQ generates for the broker.

[required] The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

[required] The unique ID that Amazon MQ generates for the broker.

Filter response by engine type.

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Filter response by engine type.

Filter response by host instance type.

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Filter response by storage type.

[required] The unique ID that Amazon MQ generates for the configuration.

[required] The unique ID that Amazon MQ generates for the configuration.

[required] The revision of the configuration.

[required] The unique ID that Amazon MQ generates for the broker.

[required] The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

[required] The unique ID that Amazon MQ generates for the configuration.

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

[required] The Amazon Resource Name (ARN) of the resource tag.

[required] The unique ID that Amazon MQ generates for the broker.

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

[required] The unique ID that Amazon MQ generates for the broker.

[required] The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

[required] The unique ID that Amazon MQ generates for the broker.

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

[required] The unique ID that Amazon MQ generates for the broker.

A list of information about the configuration.

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Enables Amazon CloudWatch logging for brokers.

The parameters that determine the WeeklyStartTime.

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Defines whether this broker is a part of a data replication pair.

[required] The unique ID that Amazon MQ generates for the configuration.

[required] Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

The description of the configuration.

[required] The unique ID that Amazon MQ generates for the broker.

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

[required] The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Defines whether the user is intended for data replication.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

[required] The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

[required] The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, ⁠arn:aws:iam::123456789:role/my-execution-role⁠. For more information, see Amazon MWAA Execution role.

[required] The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an Amazon S3 bucket for Amazon MWAA.

[required] The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.

[required] The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. For more information, see Installing custom plugins.

The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a version is required. For more information, see Installing Python dependencies.

The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.

The relative path to the startup shell script in your Amazon S3 bucket. For example, ⁠s3://mwaa-environment/startup.sh⁠.

Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.

The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.

Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

⁠3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo⁠

For more information, see Using a startup script.

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.

The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment class.

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see Create an Amazon MWAA environment.

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA).

Valid values: ⁠1.10.12⁠, ⁠2.0.2⁠, ⁠2.2.2⁠, ⁠2.4.3⁠, ⁠2.5.1⁠, ⁠2.6.3⁠, ⁠2.7.2⁠, ⁠2.8.1⁠, ⁠2.9.2⁠, ⁠2.10.1⁠, and ⁠2.10.3⁠.

Defines the Apache Airflow logs to send to CloudWatch Logs.

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". For more information, see Tagging Amazon Web Services resources.

Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

• v1 - Accepts 1.

Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.

The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

[required] The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

[required] The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

[required] The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

[required] The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

[required] The Apache Airflow REST API endpoint path to be called. For example, ⁠/dags/123456/clearTaskInstances⁠. For more information, see Apache Airflow API

[required] The HTTP method used for making Airflow REST API calls. For example, POST.

Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object.

The request body for the Apache Airflow REST API call, provided as a JSON object.

Retrieves the next page of the results.

The maximum number of results to retrieve per page. For example, 5 environments per page.

[required] The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

[required] Internal only. The name of the environment.

[required] Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

[required] The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.