String name
The name of the partner event source to activate.
String apiDestinationArn
The ARN of the API destination.
String name
The name of the API destination.
String apiDestinationState
The state of the API destination.
String connectionArn
The ARN of the connection specified for the API destination.
String invocationEndpoint
The URL to the endpoint for the API destination.
String httpMethod
The method to use to connect to the HTTP endpoint.
Integer invocationRateLimitPerSecond
The maximum number of invocations per second to send to the HTTP endpoint.
Date creationTime
A time stamp for the time that the API destination was created.
Date lastModifiedTime
A time stamp for the time that the API destination was last modified.
String archiveName
The name of the archive.
String eventSourceArn
The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
String state
The current state of the archive.
String stateReason
A description for the reason that the archive is in the current state.
Integer retentionDays
The number of days to retain events in the archive before they are deleted.
Long sizeBytes
The size of the archive, in bytes.
Long eventCount
The number of events in the archive.
Date creationTime
The time stamp for the time that the archive was created.
List<E> subnets
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
List<E> securityGroups
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
String assignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED only when LaunchType in EcsParameters is set to
FARGATE.
Integer size
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
String jobDefinition
The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.
String jobName
The name to use for this execution of the job, if the target is an AWS Batch job.
BatchArrayProperties arrayProperties
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
BatchRetryStrategy retryStrategy
The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
Integer attempts
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
String replayName
The name of the replay to cancel.
String capacityProvider
The short name of the capacity provider.
Integer weight
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
Integer base
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
String type
Specifies the type of condition. Currently the only supported value is StringEquals.
String key
Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.
String value
Specifies the value for the key. Currently, this must be the ID of the organization.
String connectionArn
The ARN of the connection.
String name
The name of the connection.
String connectionState
The state of the connection.
String stateReason
The reason that the connection is in the connection state.
String authorizationType
The authorization type specified for the connection.
Date creationTime
A time stamp for the time that the connection was created.
Date lastModifiedTime
A time stamp for the time that the connection was last modified.
Date lastAuthorizedTime
A time stamp for the time that the connection was last authorized.
String apiKeyName
The name of the header to use for the APIKeyValue used for authorization.
ConnectionBasicAuthResponseParameters basicAuthParameters
The authorization parameters for Basic authorization.
ConnectionOAuthResponseParameters oAuthParameters
The OAuth parameters to use for authorization.
ConnectionApiKeyAuthResponseParameters apiKeyAuthParameters
The API Key parameters to use for authorization.
ConnectionHttpParameters invocationHttpParameters
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
String username
The user name to use for Basic authorization.
List<E> headerParameters
Contains additional header parameters for the connection.
List<E> queryStringParameters
Contains additional query string parameters for the connection.
List<E> bodyParameters
Contains additional body string parameters for the connection.
String clientID
The client ID associated with the response to the connection request.
ConnectionOAuthClientResponseParameters clientParameters
A ConnectionOAuthClientResponseParameters object that contains details about the client parameters
returned when OAuth is specified as the authorization type.
String authorizationEndpoint
The URL to the HTTP endpoint that authorized the request.
String httpMethod
The method used to connect to the HTTP endpoint.
ConnectionHttpParameters oAuthHttpParameters
The additional HTTP parameters used for the OAuth authorization request.
String name
The name for the API destination to create.
String description
A description for the API destination to create.
String connectionArn
The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
String invocationEndpoint
The URL to the HTTP invocation endpoint for the API destination.
String httpMethod
The method to use for the request to the HTTP invocation endpoint.
Integer invocationRateLimitPerSecond
The maximum number of requests per second to send to the HTTP invocation endpoint.
String apiDestinationArn
The ARN of the API destination that was created by the request.
String apiDestinationState
The state of the API destination that was created by the request.
Date creationTime
A time stamp indicating the time that the API destination was created.
Date lastModifiedTime
A time stamp indicating the time that the API destination was last modified.
String archiveName
The name for the archive to create.
String eventSourceArn
The ARN of the event source associated with the archive.
String description
A description for the archive.
String eventPattern
An event pattern to use to filter events sent to the archive.
Integer retentionDays
The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
CreateConnectionBasicAuthRequestParameters basicAuthParameters
A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters
to use for the connection.
CreateConnectionOAuthRequestParameters oAuthParameters
A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to
use for the connection.
CreateConnectionApiKeyAuthRequestParameters apiKeyAuthParameters
A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization
parameters to use for the connection.
ConnectionHttpParameters invocationHttpParameters
A ConnectionHttpParameters object that contains the API key authorization parameters to use for the
connection. Note that if you include additional parameters for the target of a rule via
HttpParameters, including query strings, the parameters added for the connection take precedence.
CreateConnectionOAuthClientRequestParameters clientParameters
A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth
authorization.
String authorizationEndpoint
The URL to the authorization endpoint when OAuth is specified as the authorization type.
String httpMethod
The method to use for the authorization request.
ConnectionHttpParameters oAuthHttpParameters
A ConnectionHttpParameters object that contains details about the additional parameters to use for
the connection.
String name
The name for the connection to create.
String description
A description for the connection to create.
String authorizationType
The type of authorization to use for the connection.
CreateConnectionAuthRequestParameters authParameters
A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to
authorize with the endpoint.
String connectionArn
The ARN of the connection that was created by the request.
String connectionState
The state of the connection that was created by the request.
Date creationTime
A time stamp for the time that the connection was created.
Date lastModifiedTime
A time stamp for the time that the connection was last updated.
String name
The name of the new event bus.
Event bus names cannot contain the / character. 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 this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
String eventSourceName
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
List<E> tags
Tags to associate with the event bus.
String eventBusArn
The ARN of the new event bus.
String name
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 AWS 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.
String account
The AWS account ID that is permitted to create a matching partner event bus for this partner event source.
String eventSourceArn
The ARN of the partner event source.
String name
The name of the partner event source to deactivate.
String arn
The ARN of the SQS queue specified as the target for the dead-letter queue.
String name
The name of the connection to remove authorization from.
String connectionArn
The ARN of the connection that authorization was removed from.
String connectionState
The state of the connection.
Date creationTime
A time stamp for the time that the connection was created.
Date lastModifiedTime
A time stamp for the time that the connection was last updated.
Date lastAuthorizedTime
A time stamp for the time that the connection was last authorized.
String name
The name of the destination to delete.
String archiveName
The name of the archive to delete.
String name
The name of the connection to delete.
String connectionArn
The ARN of the connection that was deleted.
String connectionState
The state of the connection before it was deleted.
Date creationTime
A time stamp for the time that the connection was created.
Date lastModifiedTime
A time stamp for the time that the connection was last modified before it was deleted.
Date lastAuthorizedTime
A time stamp for the time that the connection was last authorized before it wa deleted.
String name
The name of the event bus to delete.
String name
The name of the rule.
String eventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Boolean force
If this is a managed rule, created by an AWS 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 DescribeRule or ListRules and checking
the ManagedBy field of the response.
String name
The name of the API destination to retrieve.
String apiDestinationArn
The ARN of the API destination retrieved.
String name
The name of the API destination retrieved.
String description
The description for the API destination retrieved.
String apiDestinationState
The state of the API destination retrieved.
String connectionArn
The ARN of the connection specified for the API destination retrieved.
String invocationEndpoint
The URL to use to connect to the HTTP endpoint.
String httpMethod
The method to use to connect to the HTTP endpoint.
Integer invocationRateLimitPerSecond
The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
Date creationTime
A time stamp for the time that the API destination was created.
Date lastModifiedTime
A time stamp for the time that the API destination was last modified.
String archiveName
The name of the archive to retrieve.
String archiveArn
The ARN of the archive.
String archiveName
The name of the archive.
String eventSourceArn
The ARN of the event source associated with the archive.
String description
The description of the archive.
String eventPattern
The event pattern used to filter events sent to the archive.
String state
The state of the archive.
String stateReason
The reason that the archive is in the state.
Integer retentionDays
The number of days to retain events for in the archive.
Long sizeBytes
The size of the archive in bytes.
Long eventCount
The number of events in the archive.
Date creationTime
The time at which the archive was created.
String name
The name of the connection to retrieve.
String connectionArn
The ARN of the connection retrieved.
String name
The name of the connection retrieved.
String description
The description for the connection retrieved.
String connectionState
The state of the connection retrieved.
String stateReason
The reason that the connection is in the current connection state.
String authorizationType
The type of authorization specified for the connection.
String secretArn
The ARN of the secret created from the authorization parameters specified for the connection.
ConnectionAuthResponseParameters authParameters
The parameters to use for authorization for the connection.
Date creationTime
A time stamp for the time that the connection was created.
Date lastModifiedTime
A time stamp for the time that the connection was last modified.
Date lastAuthorizedTime
A time stamp for the time that the connection was last authorized.
String name
The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.
String name
The name of the partner event source to display the details of.
String arn
The ARN of the partner event source.
String createdBy
The name of the SaaS partner that created the event source.
Date creationTime
The date and time that the event source was created.
Date expirationTime
The date and time that the event source will expire if you do not create a matching event bus.
String name
The name of the partner event source.
String state
The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
String name
The name of the event source to display.
String replayName
The name of the replay to retrieve.
String replayName
The name of the replay.
String replayArn
The ARN of the replay.
String description
The description of the replay.
String state
The current state of the replay.
String stateReason
The reason that the replay is in the current state.
String eventSourceArn
The ARN of the archive events were replayed from.
ReplayDestination destination
A ReplayDestination object that contains details about the replay.
Date eventStartTime
The time stamp of the first event that was last replayed from the archive.
Date eventEndTime
The time stamp for the last event that was replayed from the archive.
Date eventLastReplayedTime
The time that the event was last replayed.
Date replayStartTime
A time stamp for the time that the replay started.
Date replayEndTime
A time stamp for the time that the replay stopped.
String name
The name of the rule.
String arn
The Amazon Resource Name (ARN) of the rule.
String eventPattern
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
String scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
String state
Specifies whether the rule is enabled or disabled.
String description
The description of the rule.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
String managedBy
If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.
String eventBusName
The name of the event bus associated with the rule.
String createdBy
The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus
in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that
account. However, the value for CreatedBy is the account ID as the account that created the rule in
the other account.
String taskDefinitionArn
The ARN of the task definition to use if the event target is an Amazon ECS task.
Integer taskCount
The number of tasks to create based on TaskDefinition. The default is 1.
String launchType
Specifies the launch type on which your task is running. The launch type that you specify here must match one of
the launch type (compatibilities) of the target task. The FARGATE value is supported only in the
Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
NetworkConfiguration networkConfiguration
Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC
subnets and security groups associated with the task, and whether a public IP address is to be used. This
structure is required if LaunchType is FARGATE because the awsvpc mode is
required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc
network mode, the task fails.
String platformVersion
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid
platform versions, see AWS Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
String group
Specifies an ECS task group for the task. The maximum length is 255 characters.
List<E> capacityProviderStrategy
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted.
If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
Boolean enableECSManagedTags
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Boolean enableExecuteCommand
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
List<E> placementConstraints
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
List<E> placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
String propagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
String referenceId
The reference ID to use for the task.
List<E> tags
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
String arn
The ARN of the event source.
String createdBy
The name of the partner that created the event source.
Date creationTime
The date and time the event source was created.
Date expirationTime
The date and time that the event source will expire, if the AWS account doesn't create a matching event bus for it.
String name
The name of the event source.
String state
The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
List<E> pathParameterValues
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
Map<K,V> headerParameters
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Map<K,V> queryStringParameters
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Map<K,V> inputPathsMap
Map of JSON paths to be extracted from the event. You can then insert these in the template in
InputTemplate to produce the output you want to be sent to the target.
InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as
many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "AWS."
String inputTemplate
Input template where you specify placeholders that will be filled with the values of the keys from
InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps
value in brackets: <value> The InputTemplate must be valid JSON.
If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
The placeholder cannot be used as an object key.
The following example shows the syntax for using InputPathsMap and InputTemplate.
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a
slash, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following
example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
String partitionKeyPath
The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
String namePrefix
A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.
String connectionArn
The ARN of the connection specified for the API destination.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of API destinations to include in the response.
String namePrefix
A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.
String eventSourceArn
The ARN of the event source associated with the archive.
String state
The state of the archive.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of results to return.
String namePrefix
A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.
String connectionState
The state of the connection.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of connections to return.
String namePrefix
Specifying this limits the results to only those event buses with names that start with the specified prefix.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
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.
String namePrefix
Specifying this limits the results to only those partner event sources with names that start with the specified prefix.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
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.
String eventSourceName
The name of the partner event source to display account information about.
String nextToken
The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
Integer limit
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.
String namePrefix
If you specify this, the results are limited to only those partner event sources that start with the string you specify.
String nextToken
The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
Integer limit
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.
String namePrefix
A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.
String state
The state of the replay.
String eventSourceArn
The ARN of the event source associated with the replay.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of replays to retrieve.
String targetArn
The Amazon Resource Name (ARN) of the target resource.
String eventBusName
The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of results to return.
String namePrefix
The prefix matching the rule name.
String eventBusName
The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of results to return.
String resourceARN
The ARN of the EventBridge resource for which you want to view tags.
String rule
The name of the rule.
String eventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
String nextToken
The token returned by a previous call to retrieve the next set of results.
Integer limit
The maximum number of results to return.
AwsVpcConfiguration awsvpcConfiguration
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address
is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
String account
The AWS account ID that the partner event source was offered to.
Date creationTime
The date and time the event source was created.
Date expirationTime
The date and time that the event source will expire, if the AWS account doesn't create a matching event bus for it.
String state
The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
String type
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
String expression
A cluster query language expression to apply to the constraint. You cannot specify an expression if the
constraint type is distinctInstance. To learn more, see Cluster Query
Language in the Amazon Elastic Container Service Developer Guide.
String type
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
String field
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
Date time
String source
The source of the event.
List<E> resources
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
String detailType
Free-form string used to decide what fields to expect in the event detail.
String detail
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
String eventBusName
The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.
String traceHeader
An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.
To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.
Integer failedEntryCount
The number of failed entries.
List<E> entries
The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.
Date time
The date and time of the event.
String source
The event source that is generating the evntry.
List<E> resources
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
String detailType
A free-form string used to decide what fields to expect in the event detail.
String detail
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
String eventBusName
The name of the event bus associated with the rule. If you omit this, the default event bus is used.
String action
The action that you are enabling the other account to perform. Currently, this must be
events:PutEvents.
String principal
The 12-digit AWS 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.
String statementId
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
RemovePermission.
Condition condition
This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.
If you specify Condition with an AWS 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.
String policy
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.
String name
The name of the rule that you are creating or updating.
String scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
String eventPattern
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
String state
Indicates whether the rule is enabled or disabled.
String description
A description of the rule.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
List<E> tags
The list of key-value pairs to associate with the rule.
String eventBusName
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
String ruleArn
The Amazon Resource Name (ARN) of the rule.
String targetId
The ID of the target.
String errorCode
The error code that indicates why the target addition failed. If the value is
ConcurrentModificationException, too many requests were made at the same time.
String errorMessage
The error message that explains why the target addition failed.
String secretManagerArn
The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
String database
The name of the database. Required when authenticating using temporary credentials.
String dbUser
The database user name. Required when authenticating using temporary credentials.
String sql
The SQL statement text to run.
String statementName
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
Boolean withEvent
Indicates whether to send an event back to EventBridge after the SQL statement runs.
String statementId
The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
Boolean removeAllPermissions
Specifies whether to remove all permissions.
String eventBusName
The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.
String rule
The name of the rule.
String eventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
List<E> ids
The IDs of the targets to remove from the rule.
Boolean force
If this is a managed rule, created by an AWS 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 DescribeRule or ListRules and checking
the ManagedBy field of the response.
String targetId
The ID of the target.
String errorCode
The error code that indicates why the target removal failed. If the value is
ConcurrentModificationException, too many requests were made at the same time.
String errorMessage
The error message that explains why the target removal failed.
String replayName
The name of the replay.
String eventSourceArn
The ARN of the archive to replay event from.
String state
The current state of the replay.
String stateReason
A description of why the replay is in the current state.
Date eventStartTime
A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time.
Date eventEndTime
A time stamp for the time to start replaying events. Any event with a creation time prior to the
EventEndTime specified is replayed.
Date eventLastReplayedTime
A time stamp for the time that the last event was replayed.
Date replayStartTime
A time stamp for the time that the replay started.
Date replayEndTime
A time stamp for the time that the replay completed.
Integer maximumRetryAttempts
The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the
maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.
Integer maximumEventAgeInSeconds
The maximum amount of time, in seconds, to continue to make retry attempts.
String name
The name of the rule.
String arn
The Amazon Resource Name (ARN) of the rule.
String eventPattern
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
String state
The state of the rule.
String description
The description of the rule.
String scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
String roleArn
The Amazon Resource Name (ARN) of the role that is used for target invocation.
String managedBy
If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.
String eventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
String messageGroupId
The FIFO message group ID to use as the target.
String replayName
The name of the replay to start.
String description
A description for the replay to start.
String eventSourceArn
The ARN of the archive to replay events from.
Date eventStartTime
A time stamp for the time to start replaying events. Only events that occurred between the
EventStartTime and EventEndTime are replayed.
Date eventEndTime
A time stamp for the time to stop replaying events. Only events that occurred between the
EventStartTime and EventEndTime are replayed.
ReplayDestination destination
A ReplayDestination object that includes details about the destination for the replay.
String id
The ID of the target.
String arn
The Amazon Resource Name (ARN) of the target.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
String input
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
String inputPath
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
InputTransformer inputTransformer
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
KinesisParameters kinesisParameters
The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If
you do not include this parameter, the default is to use the eventId as the partition key.
RunCommandParameters runCommandParameters
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
EcsParameters ecsParameters
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
BatchParameters batchParameters
If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.
SqsParameters sqsParameters
Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
HttpParameters httpParameters
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
RedshiftDataParameters redshiftDataParameters
Contains the Redshift Data API parameters to use when the target is a Redshift cluster.
If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke the Redshift Data API ExecuteStatement based on EventBridge events.
SageMakerPipelineParameters sageMakerPipelineParameters
Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
DeadLetterConfig deadLetterConfig
The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
RetryPolicy retryPolicy
The RetryPolicy object that contains the retry policy configuration to use for the dead-letter
queue.
String eventPattern
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
String event
The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in AWS Events, and the following fields are mandatory:
id
account
source
time
region
resources
detail-type
Boolean result
Indicates whether the event matches the event pattern.
String name
The name of the API destination to update.
String description
The name of the API destination to update.
String connectionArn
The ARN of the connection to use for the API destination.
String invocationEndpoint
The URL to the endpoint to use for the API destination.
String httpMethod
The method to use for the API destination.
Integer invocationRateLimitPerSecond
The maximum number of invocations per second to send to the API destination.
String apiDestinationArn
The ARN of the API destination that was updated.
String apiDestinationState
The state of the API destination that was updated.
Date creationTime
A time stamp for the time that the API destination was created.
Date lastModifiedTime
A time stamp for the time that the API destination was last modified.
String archiveName
The name of the archive to update.
String description
The description for the archive.
String eventPattern
The event pattern to use to filter events sent to the archive.
Integer retentionDays
The number of days to retain events in the archive.
UpdateConnectionBasicAuthRequestParameters basicAuthParameters
A UpdateConnectionBasicAuthRequestParameters object that contains the authorization parameters for
Basic authorization.
UpdateConnectionOAuthRequestParameters oAuthParameters
A UpdateConnectionOAuthRequestParameters object that contains the authorization parameters for OAuth
authorization.
UpdateConnectionApiKeyAuthRequestParameters apiKeyAuthParameters
A UpdateConnectionApiKeyAuthRequestParameters object that contains the authorization parameters for
API key authorization.
ConnectionHttpParameters invocationHttpParameters
A ConnectionHttpParameters object that contains the additional parameters to use for the connection.
UpdateConnectionOAuthClientRequestParameters clientParameters
A UpdateConnectionOAuthClientRequestParameters object that contains the client parameters to use for
the connection when OAuth is specified as the authorization type.
String authorizationEndpoint
The URL to the authorization endpoint when OAuth is specified as the authorization type.
String httpMethod
The method used to connect to the HTTP endpoint.
ConnectionHttpParameters oAuthHttpParameters
The additional HTTP parameters used for the OAuth authorization request.
String name
The name of the connection to update.
String description
A description for the connection.
String authorizationType
The type of authorization to use for the connection.
UpdateConnectionAuthRequestParameters authParameters
The authorization parameters to use for the connection.
String connectionArn
The ARN of the connection that was updated.
String connectionState
The state of the connection that was updated.
Date creationTime
A time stamp for the time that the connection was created.
Date lastModifiedTime
A time stamp for the time that the connection was last modified.
Date lastAuthorizedTime
A time stamp for the time that the connection was last authorized.
Copyright © 2021. All rights reserved.