String name
The name of the partner event source to activate.
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 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 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
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 archiveName
The name of the archive to delete.
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 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 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.
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 path wildcards ("*").
Map<K,V> headerParameters
The headers that need to be sent as part of request invoking the API Gateway REST API.
Map<K,V> queryStringParameters
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.
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 10 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.
Object values cannot include quote marks.
 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>\""
 
 }
 
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 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
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.
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.
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.
If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.
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.
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.
Boolean result
Indicates whether the event matches the event pattern.
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.
Copyright © 2021. All rights reserved.