"documentation":"<p>Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.</p>"
"documentation":"<p>Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.</p>"
"documentation":"<p>Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.</p>"
"documentation":"<p>Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.</p>"
"documentation":"<p>Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.</p> <p>Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types. </p> <p>A partner event source creates events based on resources within the SaaS partner's service or application.</p> <p>An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.</p> <p>Partner event source names follow this format:</p> <p> <code> <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i> </code> </p> <p> <i>partner_name</i> is determined during partner registration and identifies the partner to AWS customers. <i>event_namespace</i> is determined by the partner and is a way for the partner to categorize their events. <i>event_name</i> is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of <i>event_namespace</i> and <i>event_name</i> should help AWS customers decide whether to create an event bus to receive these events.</p>"
"documentation":"<p>You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. </p> <p>When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.</p> <p>To activate a deactivated partner event source, use <a>ActivateEventSource</a>.</p>"
"documentation":"<p>Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.</p>"
"documentation":"<p>Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.</p>"
"documentation":"<p>This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.</p> <p>When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.</p> <p/>"
"documentation":"<p>Deletes the specified rule.</p> <p>Before you can delete the rule, you must remove all targets, using <a>RemoveTargets</a>.</p> <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.</p> <p>Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the <code>Force</code> option, but you should do so only if you are sure the other service is not still using that rule.</p>"
"documentation":"<p>Displays details about an event bus in your account. This can include the external AWS accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.</p> <p> To enable your account to receive events from other accounts on its default event bus, use <a>PutPermission</a>.</p> <p>For more information about partner event buses, see <a>CreateEventBus</a>.</p>"
"documentation":"<p>An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use <a>DescribeEventSource</a> to see details about a partner event source that is shared with them.</p>"
"documentation":"<p>Retrieves details about a replay. Use <code>DescribeReplay</code> to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use <code>StartReplay</code> and specify an <code>EventStartTime</code> and an <code>EventEndTime</code> that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use <code>DescribeReplay</code> to determine the progress of a replay. The value returned for <code>EventLastReplayedTime</code> indicates the time within the specified time range associated with the last event replayed.</p>"
"documentation":"<p>Describes the specified rule.</p> <p>DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use <a>ListTargetsByRule</a>.</p>"
"documentation":"<p>Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.</p> <p>When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.</p>"
"documentation":"<p>Enables the specified rule. If the rule does not exist, the operation fails.</p> <p>When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.</p>"
"documentation":"<p>Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.</p>"
"documentation":"<p>You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see <a>CreateEventBus</a>.</p>"
"documentation":"<p>An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.</p>"
"documentation":"<p>An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.</p>"
"documentation":"<p>Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.</p>"
"documentation":"<p>Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.</p>"
"documentation":"<p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.</p> <p>ListRules does not list the targets of a rule. To see the targets associated with a rule, use <a>ListTargetsByRule</a>.</p>"
"documentation":"<p>Running <code>PutPermission</code> permits the specified AWS account or AWS organization to put events to the specified <i>event bus</i>. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account. </p> <p>For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.</p> <p>To enable multiple AWS accounts to put events to your event bus, run <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run <code>PutPermission</code> once specifying <code>Principal</code> as \"*\" and specifying the AWS organization ID in <code>Condition</code>, to grant permissions to all accounts in that organization.</p> <p>If you grant permissions using an organization, then accounts in that organization must specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to add your account's event bus as a target. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html\">Sending and Receiving Events Between AWS Accounts</a> in the <i>Amazon EventBridge User Guide</i>.</p> <p>The permission policy on the default event bus cannot exceed 10 KB in size.</p>"
"documentation":"<p>Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using <a>DisableRule</a>.</p> <p>A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see <a>CreateEventBus</a>.</p> <p>If you are updating an existing rule, the rule is replaced with what you specify in this <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values for those arguments are not kept. Instead, they are replaced with null values.</p> <p>When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.</p> <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.</p> <p>When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the <code>PutRule</code> operation and assign tags, you must have both the <code>events:PutRule</code> and <code>events:TagResource</code> permissions.</p> <p>If you are updating an existing rule, any tags you specify in the <code>PutRule</code> operation are ignored. To update the tags of an existing rule, use <a>TagResource</a> and <a>UntagResource</a>.</p> <p>Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.</p> <p>In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.</p> <p>To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. </p> <p>An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html\">Managing Your Costs with Budgets</a>.</p>"
"documentation":"<p>Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.</p> <p>Targets are the resources that are invoked when a rule is triggered.</p> <p>You can configure the following as targets for Events:</p> <ul> <li> <p>EC2 instances</p> </li> <li> <p>SSM Run Command</p> </li> <li> <p>SSM Automation</p> </li> <li> <p>AWS Lambda functions</p> </li> <li> <p>Data streams in Amazon Kinesis Data Streams</p> </li> <li> <p>Data delivery streams in Amazon Kinesis Data Firehose</p> </li> <li> <p>Amazon ECS tasks</p> </li> <li> <p>AWS Step Functions state machines</p> </li> <li> <p>AWS Batch jobs</p> </li> <li> <p>AWS CodeBuild projects</p> </li> <li> <p>Pipelines in AWS CodePipeline</p> </li> <li> <p>Amazon Inspector assessment templates</p> </li> <li> <p>Amazon SNS topics</p> </li> <li> <p>Amazon SQS queues, including FIFO queues</p> </li> <li> <p>The default event bus of another AWS account</p> </li> <li> <p>Amazon API Gateway REST APIs</p> </li> <li> <p>Redshift Clusters to invoke Data API ExecuteStatement on</p> </li> <li> <p>Custom/SaaS HTTPS APIs via EventBridge API Destinations</p> </li> </ul> <p>Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are <code>EC2 CreateSnapshot API call</code>, <code>EC2 RebootInstances API call</code>, <code>EC2 StopInstances API call</code>, and <code>EC2 TerminateInstances API call</code>. </p> <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2 instances with one rule, you can use the <code>RunCommandParameters</code> field.</p> <p>To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html\">Authentication and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p> <p>If another AWS account is in the same region and has granted you permission (using <code>PutPermission</code>), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the <code>Arn</code> value when you run <code>PutTargets</code>. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see <a href=\"https://aws.amazon.com/eventbridge/pricing/\">Amazon EventBridge (CloudWatch Events) Pricing</a>.</p> <note> <p> <code>Input</code>, <code>InputPath</code>, and <code>InputTransformer</code> are not available with <code>PutTarget</code> if the target is an event bus of a different AWS account.</p> </note> <p>If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a <code>RoleArn</code> with proper permissions in the <code>Target</code> structure. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html\">SendingandReceivingEventsBetweenAWSAccounts</a>inthe<i>AmazonEventBridgeUserGuide</i>.</p><p>Formoreinformationaboutenablingcross-accountevents,see<a>PutPermission</a>.</p><p><b>Input</b>,<b>InputPath</
"documentation":"<p>Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the <code>StatementId</code> value that you associated with the account when you granted it permission with <code>PutPermission</code>. You can find the <code>StatementId</code> by using <a>DescribeEventBus</a>.</p>"
"documentation":"<p>Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.</p> <p>When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>"
"documentation":"<p>Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an <code>EventStartTime</code> and an <code>EventEndTime</code> that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use <code>DescribeReplay</code> to determine the progress of a replay. The value returned for <code>EventLastReplayedTime</code> indicates the time within the specified time range associated with the last event replayed.</p>"
"documentation":"<p>Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a resource.</p>"
"documentation":"<p>Tests whether the specified event pattern matches the provided event.</p> <p>Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.</p>"
"documentation":"<p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.</p>"
"documentation":"<p>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Specifies whether the task's elastic network interface receives a public IP address. You can specify <code>ENABLED</code> only when <code>LaunchType</code> in <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>"
"documentation":"<p>This structure specifies 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 <code>awsvpc</code> network mode.</p>"
"documentation":"<p>The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.</p>"
}
},
"documentation":"<p>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.</p>"
},
"BatchParameters":{
"type":"structure",
"required":[
"JobDefinition",
"JobName"
],
"members":{
"JobDefinition":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"JobName":{
"shape":"String",
"documentation":"<p>The name to use for this execution of the job, if the target is an AWS Batch job.</p>"
},
"ArrayProperties":{
"shape":"BatchArrayProperties",
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.</p>"
"documentation":"<p>A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields. The <code>Value</code> field specifies the ID of the AWS organization. Following is an example value for <code>Condition</code>:</p> <p> <code>'{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\": \"o-1234567890\"}'</code> </p>"
"documentation":"<p>The authorization parameters for Basic authorization.</p>"
},
"OAuthParameters":{
"shape":"ConnectionOAuthResponseParameters",
"documentation":"<p>The OAuth parameters to use for authorization.</p>"
},
"ApiKeyAuthParameters":{
"shape":"ConnectionApiKeyAuthResponseParameters",
"documentation":"<p>The API Key parameters to use for authorization.</p>"
},
"InvocationHttpParameters":{
"shape":"ConnectionHttpParameters",
"documentation":"<p>Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.</p>"
}
},
"documentation":"<p>Contains the authorization parameters to use for the connection.</p>"
},
"ConnectionAuthorizationType":{
"type":"string",
"enum":[
"BASIC",
"OAUTH_CLIENT_CREDENTIALS",
"API_KEY"
]
},
"ConnectionBasicAuthResponseParameters":{
"type":"structure",
"members":{
"Username":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The user name to use for Basic authorization.</p>"
}
},
"documentation":"<p>Contains the authorization parameters for the connection if Basic is specified as the authorization type.</p>"
},
"ConnectionBodyParameter":{
"type":"structure",
"members":{
"Key":{
"shape":"String",
"documentation":"<p>The key for the parameter.</p>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value associated with the key.</p>"
},
"IsValueSecret":{
"shape":"Boolean",
"documentation":"<p>Specified whether the value is secret.</p>"
}
},
"documentation":"<p>Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.</p>"
},
"ConnectionBodyParametersList":{
"type":"list",
"member":{"shape":"ConnectionBodyParameter"},
"max":100,
"min":0
},
"ConnectionDescription":{
"type":"string",
"max":512,
"pattern":".*"
},
"ConnectionHeaderParameter":{
"type":"structure",
"members":{
"Key":{
"shape":"HeaderKey",
"documentation":"<p>The key for the parameter.</p>"
},
"Value":{
"shape":"HeaderValue",
"documentation":"<p>The value associated with the key.</p>"
},
"IsValueSecret":{
"shape":"Boolean",
"documentation":"<p>Specified whether the value is a secret.</p>"
}
},
"documentation":"<p>Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.</p>"
},
"ConnectionHeaderParametersList":{
"type":"list",
"member":{"shape":"ConnectionHeaderParameter"},
"max":100,
"min":0
},
"ConnectionHttpParameters":{
"type":"structure",
"members":{
"HeaderParameters":{
"shape":"ConnectionHeaderParametersList",
"documentation":"<p>Contains additional header parameters for the connection.</p>"
},
"QueryStringParameters":{
"shape":"ConnectionQueryStringParametersList",
"documentation":"<p>Contains additional query string parameters for the connection.</p>"
},
"BodyParameters":{
"shape":"ConnectionBodyParametersList",
"documentation":"<p>Contains additional body string parameters for the connection.</p>"
}
},
"documentation":"<p>Contains additional parameters for the connection.</p>"
},
"ConnectionName":{
"type":"string",
"max":64,
"min":1,
"pattern":"[\\.\\-_A-Za-z0-9]+"
},
"ConnectionOAuthClientResponseParameters":{
"type":"structure",
"members":{
"ClientID":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The client ID associated with the response to the connection request.</p>"
}
},
"documentation":"<p>Contains the client response parameters for the connection when OAuth is specified as the authorization type.</p>"
"documentation":"<p>A <code>ConnectionOAuthClientResponseParameters</code> object that contains details about the client parameters returned when OAuth is specified as the authorization type.</p>"
},
"AuthorizationEndpoint":{
"shape":"HttpsEndpoint",
"documentation":"<p>The URL to the HTTP endpoint that authorized the request.</p>"
},
"HttpMethod":{
"shape":"ConnectionOAuthHttpMethod",
"documentation":"<p>The method used to connect to the HTTP endpoint.</p>"
},
"OAuthHttpParameters":{
"shape":"ConnectionHttpParameters",
"documentation":"<p>The additional HTTP parameters used for the OAuth authorization request.</p>"
}
},
"documentation":"<p>Contains the response parameters when OAuth is specified as the authorization type.</p>"
},
"ConnectionQueryStringParameter":{
"type":"structure",
"members":{
"Key":{
"shape":"QueryStringKey",
"documentation":"<p>The key for a query string parameter.</p>"
},
"Value":{
"shape":"QueryStringValue",
"documentation":"<p>The value associated with the key for the query string parameter.</p>"
},
"IsValueSecret":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the value is secret.</p>"
}
},
"documentation":"<p>Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.</p>"
"documentation":"<p>The name for the API destination to create.</p>"
},
"Description":{
"shape":"ApiDestinationDescription",
"documentation":"<p>A description for the API destination to create.</p>"
},
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.</p>"
},
"InvocationEndpoint":{
"shape":"HttpsEndpoint",
"documentation":"<p>The URL to the HTTP invocation endpoint for the API destination.</p>"
},
"HttpMethod":{
"shape":"ApiDestinationHttpMethod",
"documentation":"<p>The method to use for the request to the HTTP invocation endpoint.</p>"
"documentation":"<p>A <code>CreateConnectionBasicAuthRequestParameters</code> object that contains the Basic authorization parameters to use for the connection.</p>"
},
"OAuthParameters":{
"shape":"CreateConnectionOAuthRequestParameters",
"documentation":"<p>A <code>CreateConnectionOAuthRequestParameters</code> object that contains the OAuth authorization parameters to use for the connection.</p>"
"documentation":"<p>A <code>CreateConnectionApiKeyAuthRequestParameters</code> object that contains the API key authorization parameters to use for the connection.</p>"
},
"InvocationHttpParameters":{
"shape":"ConnectionHttpParameters",
"documentation":"<p>A <code>ConnectionHttpParameters</code> 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 <code>HttpParameters</code>, including query strings, the parameters added for the connection take precedence.</p>"
}
},
"documentation":"<p>Contains the authorization parameters for the connection.</p>"
},
"CreateConnectionBasicAuthRequestParameters":{
"type":"structure",
"required":[
"Username",
"Password"
],
"members":{
"Username":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The user name to use for Basic authorization.</p>"
},
"Password":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The password associated with the user name to use for Basic authorization.</p>"
}
},
"documentation":"<p>Contains the Basic authorization parameters to use for the connection.</p>"
},
"CreateConnectionOAuthClientRequestParameters":{
"type":"structure",
"required":[
"ClientID",
"ClientSecret"
],
"members":{
"ClientID":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The client ID to use for OAuth authorization for the connection.</p>"
},
"ClientSecret":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The client secret associated with the client ID to use for OAuth authorization for the connection.</p>"
}
},
"documentation":"<p>Contains the Basic authorization parameters to use for the connection.</p>"
"documentation":"<p>A <code>CreateConnectionOAuthClientRequestParameters</code> object that contains the client parameters for OAuth authorization.</p>"
},
"AuthorizationEndpoint":{
"shape":"HttpsEndpoint",
"documentation":"<p>The URL to the authorization endpoint when OAuth is specified as the authorization type.</p>"
},
"HttpMethod":{
"shape":"ConnectionOAuthHttpMethod",
"documentation":"<p>The method to use for the authorization request.</p>"
},
"OAuthHttpParameters":{
"shape":"ConnectionHttpParameters",
"documentation":"<p>A <code>ConnectionHttpParameters</code> object that contains details about the additional parameters to use for the connection.</p>"
}
},
"documentation":"<p>Contains the OAuth authorization parameters to use for the connection.</p>"
},
"CreateConnectionRequest":{
"type":"structure",
"required":[
"Name",
"AuthorizationType",
"AuthParameters"
],
"members":{
"Name":{
"shape":"ConnectionName",
"documentation":"<p>The name for the connection to create.</p>"
},
"Description":{
"shape":"ConnectionDescription",
"documentation":"<p>A description for the connection to create.</p>"
},
"AuthorizationType":{
"shape":"ConnectionAuthorizationType",
"documentation":"<p>The type of authorization to use for the connection.</p>"
},
"AuthParameters":{
"shape":"CreateConnectionAuthRequestParameters",
"documentation":"<p>A <code>CreateConnectionAuthRequestParameters</code> object that contains the authorization parameters to use to authorize with the endpoint. </p>"
}
}
},
"CreateConnectionResponse":{
"type":"structure",
"members":{
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The ARN of the connection that was created by the request.</p>"
},
"ConnectionState":{
"shape":"ConnectionState",
"documentation":"<p>The state of the connection that was created by the request.</p>"
"documentation":"<p>The name of the new event bus. </p> <p>Event bus names cannot contain the / character. You can't use the name <code>default</code> for a custom event bus, as this name is already used for your account's default event bus.</p> <p>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.</p>"
"documentation":"<p>The ARN of the new event bus.</p>"
}
}
},
"CreatePartnerEventSourceRequest":{
"type":"structure",
"required":[
"Name",
"Account"
],
"members":{
"Name":{
"shape":"EventSourceName",
"documentation":"<p>The name of the partner event source. This name must be unique and must be in the format <code> <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i> </code>. 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.</p>"
"documentation":"<p>If this is a managed rule, created by an AWS service on your behalf, you must specify <code>Force</code> as <code>True</code> 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 <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>"
"documentation":"<p>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.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the API destination was created.</p>"
},
"LastModifiedTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the API destination was last modified.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The event pattern. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The name of the event bus associated with the rule.</p>"
},
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The account ID of the user that created the rule. If you use <code>PutRule</code> 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 <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>"
"documentation":"<p>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 <code>FARGATE</code> value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html\">AWS Fargate on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>Use this structure if the ECS task uses the <code>awsvpc</code> 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 <code>LaunchType</code> is <code>FARGATE</code> because the <code>awsvpc</code> mode is required for Fargate tasks.</p> <p>If you specify <code>NetworkConfiguration</code> when the target ECS task does not use the <code>awsvpc</code> network mode, the task fails.</p>"
"documentation":"<p>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <code>1.1.0</code>.</p> <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more information about valid platform versions, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The name of the event bus.</p>"
},
"Arn":{
"shape":"String",
"documentation":"<p>The ARN of the event bus.</p>"
},
"Policy":{
"shape":"String",
"documentation":"<p>The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.</p>"
}
},
"documentation":"<p>An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.</p>"
"documentation":"<p>The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</p>"
"documentation":"<p>These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.</p>"
"documentation":"<p>Map of JSON paths to be extracted from the event. You can then insert these in the template in <code>InputTemplate</code> to produce the output you want to be sent to the target.</p> <p> <code>InputPathsMap</code> 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.</p> <p>The keys cannot start with \"AWS.\" </p>"
"documentation":"<p>Input template where you specify placeholders that will be filled with the values of the keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each <code>InputPathsMaps</code> value in brackets: <<i>value</i>> The InputTemplate must be valid JSON.</p> <p>If <code>InputTemplate</code> is a JSON object (surrounded by curly braces), the following restrictions apply:</p> <ul> <li> <p>The placeholder cannot be used as an object key.</p> </li> </ul> <p>The following example shows the syntax for using <code>InputPathsMap</code> and <code>InputTemplate</code>.</p> <p> <code> \"InputTransformer\":</code> </p> <p> <code>{</code> </p> <p> <code>\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},</code> </p> <p> <code>\"InputTemplate\": \"<instance> is in state <status>\"</code> </p> <p> <code>}</code> </p> <p>To have the <code>InputTemplate</code> include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:</p> <p> <code> \"InputTransformer\":</code> </p> <p> <code>{</code> </p> <p> <code>\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},</code> </p> <p> <code>\"InputTemplate\": \"<instance> is in state \\\"<status>\\\"\"</code> </p> <p> <code>}</code> </p> <p>The <code>InputTemplate</code> can also be valid JSON with varibles in quotes or out, as in the following example:</p> <p> <code> \"InputTransformer\":</code> </p> <p> <code>{</code> </p> <p> <code>\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},</code> </p> <p> <code>\"InputTemplate\": '{\"myInstance\": <instance>,\"myStatus\": \"<instance> is in state \\\"<status>\\\"\"}'</code> </p> <p> <code>}</code> </p>"
"documentation":"<p>Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.</p>"
"documentation":"<p>The JSON path to be extracted from the event and used as the partition key. For more information, see <a href=\"https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key\">Amazon Kinesis Streams Key Concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>"
"documentation":"<p>This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the <code>eventId</code> as the partition key.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to <code>DeleteRule</code> or <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>, <code>PutRule</code>, <code>TagResource</code>, or <code>UntagResource</code>. </p>",
"documentation":"<p>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 <code>awsvpc</code> network mode.</p>"
"documentation":"<p>The ARN of the partner event source.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of the partner event source.</p>"
}
},
"documentation":"<p>A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.</p>"
},
"PartnerEventSourceAccount":{
"type":"structure",
"members":{
"Account":{
"shape":"AccountId",
"documentation":"<p>The AWS account ID that the partner event source was offered to.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The time stamp of the event, per <a href=\"https://www.rfc-editor.org/rfc/rfc3339.txt\">RFC3339</a>. If no time stamp is provided, the time stamp of the <a>PutEvents</a> call is used.</p>"
"documentation":"<p>AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.</p> <p>To learn more about X-Ray trace headers, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader\">Tracing header</a> in the AWS X-Ray Developer Guide.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.</p>"
"documentation":"<p>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.</p> <p>If you specify \"*\" without specifying <code>Condition</code>, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an <code>account</code> 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.</p>"
"documentation":"<p>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 <code>StatementId</code> when you run <a>RemovePermission</a>.</p>"
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html\">What Is AWS Organizations</a> in the <i>AWS Organizations User Guide</i>.</p> <p>If you specify <code>Condition</code> with an AWS organization ID, and specify \"*\" as the value for <code>Principal</code>, you grant permission to all the accounts in the named organization.</p> <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>"
"documentation":"<p>A JSON string that describes the permission policy statement. You can include a <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>, <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>"
"documentation":"<p>The event pattern. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"
"documentation":"<p>The error code that indicates why the target addition failed. If the value is <code>ConcurrentModificationException</code>, too many requests were made at the same time.</p>"
"documentation":"<p>The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>The name of the database. Required when authenticating using temporary credentials.</p>"
},
"DbUser":{
"shape":"DbUser",
"documentation":"<p>The database user name. Required when authenticating using temporary credentials.</p>"
},
"Sql":{
"shape":"Sql",
"documentation":"<p>The SQL statement text to run.</p>"
},
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query.</p>"
},
"WithEvent":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to send an event back to EventBridge after the SQL statement runs.</p>"
}
},
"documentation":"<p>These are custom parameters to be used when the target is a Redshift cluster to invoke the Redshift Data API ExecuteStatement based on EventBridge events.</p>"
"documentation":"<p>If this is a managed rule, created by an AWS service on your behalf, you must specify <code>Force</code> as <code>True</code> 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 <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>"
"documentation":"<p>The error code that indicates why the target removal failed. If the value is <code>ConcurrentModificationException</code>, too many requests were made at the same time.</p>"
"documentation":"<p>The ARN of the archive to replay event from.</p>"
},
"State":{
"shape":"ReplayState",
"documentation":"<p>The current state of the replay.</p>"
},
"StateReason":{
"shape":"ReplayStateReason",
"documentation":"<p>A description of why the replay is in the current state.</p>"
},
"EventStartTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time to start replaying events. This is determined by the time in the event as described in <a href=\"https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time\">Time</a>.</p>"
},
"EventEndTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time to start replaying events. Any event with a creation time prior to the <code>EventEndTime</code> specified is replayed.</p>"
},
"EventLastReplayedTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the last event was replayed.</p>"
},
"ReplayStartTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the replay started.</p>"
},
"ReplayEndTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the replay completed.</p>"
}
},
"documentation":"<p>A <code>Replay</code> object that contains details about a replay.</p>"
"documentation":"<p>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 <code>MaximumEventAgeInSeconds</code> is met.</p>"
},
"MaximumEventAgeInSeconds":{
"shape":"MaximumEventAgeInSeconds",
"documentation":"<p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>"
}
},
"documentation":"<p>A <code>RetryPolicy</code> object that includes information about the retry policy settings.</p>"
"documentation":"<p>The event pattern of the rule. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command. </p>"
"documentation":"<p>Can be either <code>tag:</code> <i>tag-key</i> or <code>InstanceIds</code>.</p>"
},
"Values":{
"shape":"RunCommandTargetValues",
"documentation":"<p>If <code>Key</code> is <code>tag:</code> <i>tag-key</i>, <code>Values</code> is a list of tag values. If <code>Key</code> is <code>InstanceIds</code>, <code>Values</code> is a list of Amazon EC2 instance IDs.</p>"
"documentation":"<p>Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each <code>RunCommandTarget</code> block can include only one key, but this key may specify multiple values.</p>"
"documentation":"<p>The name of the replay to start.</p>"
},
"Description":{
"shape":"ReplayDescription",
"documentation":"<p>A description for the replay to start.</p>"
},
"EventSourceArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the archive to replay events from.</p>"
},
"EventStartTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time to start replaying events. Only events that occurred between the <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>"
},
"EventEndTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time to stop replaying events. Only events that occurred between the <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>"
},
"Destination":{
"shape":"ReplayDestination",
"documentation":"<p>A <code>ReplayDestination</code> object that includes details about the destination for the replay.</p>"
}
}
},
"StartReplayResponse":{
"type":"structure",
"members":{
"ReplayArn":{
"shape":"ReplayArn",
"documentation":"<p>The ARN of the replay.</p>"
},
"State":{
"shape":"ReplayState",
"documentation":"<p>The state of the replay.</p>"
},
"StateReason":{
"shape":"ReplayStateReason",
"documentation":"<p>The reason that the replay is in the state.</p>"
},
"ReplayStartTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the replay started.</p>"
"documentation":"<p>A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the target.</p>"
},
"RoleArn":{
"shape":"RoleArn",
"documentation":"<p>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.</p>"
"documentation":"<p>Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see <a href=\"http://www.rfc-editor.org/rfc/rfc7159.txt\">The JavaScript Object Notation (JSON) Data Interchange Format</a>.</p>"
"documentation":"<p>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 <a href=\"http://goessner.net/articles/JsonPath/\">JSONPath</a>.</p>"
},
"InputTransformer":{
"shape":"InputTransformer",
"documentation":"<p>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.</p>"
"documentation":"<p>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 <code>eventId</code> as the partition key.</p>"
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Task Definitions </a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
"documentation":"<p>If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/jobs.html\">Jobs</a> in the <i>AWS Batch User Guide</i>.</p>"
"documentation":"<p>Contains the message group ID to use when the target is a FIFO queue.</p> <p>If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.</p>"
"documentation":"<p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.</p> <p>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.</p>"
"documentation":"<p>Contains the Redshift Data API parameters to use when the target is a Redshift cluster.</p> <p>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.</p>"
},
"DeadLetterConfig":{
"shape":"DeadLetterConfig",
"documentation":"<p>The <code>DeadLetterConfig</code> that defines the target queue to send dead-letter queue events to.</p>"
},
"RetryPolicy":{
"shape":"RetryPolicy",
"documentation":"<p>The <code>RetryPolicy</code> object that contains the retry policy configuration to use for the dead-letter queue.</p>"
"documentation":"<p>Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see <a>PutTargets</a>.</p> <p>If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a <code>RoleArn</code> with proper permissions in the <code>Target</code> structure. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html\">Sending and Receiving Events Between AWS Accounts</a> in the <i>Amazon EventBridge User Guide</i>.</p>"
"documentation":"<p>The event pattern. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"
"documentation":"<p>The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html\">AWS Events</a>, and the following fields are mandatory:</p> <ul> <li> <p> <code>id</code> </p> </li> <li> <p> <code>account</code> </p> </li> <li> <p> <code>source</code> </p> </li> <li> <p> <code>time</code> </p> </li> <li> <p> <code>region</code> </p> </li> <li> <p> <code>resources</code> </p> </li> <li> <p> <code>detail-type</code> </p> </li> </ul>"
"documentation":"<p>A <code>UpdateConnectionBasicAuthRequestParameters</code> object that contains the authorization parameters for Basic authorization.</p>"
},
"OAuthParameters":{
"shape":"UpdateConnectionOAuthRequestParameters",
"documentation":"<p>A <code>UpdateConnectionOAuthRequestParameters</code> object that contains the authorization parameters for OAuth authorization.</p>"
"documentation":"<p>A <code>UpdateConnectionApiKeyAuthRequestParameters</code> object that contains the authorization parameters for API key authorization.</p>"
},
"InvocationHttpParameters":{
"shape":"ConnectionHttpParameters",
"documentation":"<p>A <code>ConnectionHttpParameters</code> object that contains the additional parameters to use for the connection.</p>"
}
},
"documentation":"<p>Contains the additional parameters to use for the connection.</p>"
},
"UpdateConnectionBasicAuthRequestParameters":{
"type":"structure",
"members":{
"Username":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The user name to use for Basic authorization.</p>"
},
"Password":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The password associated with the user name to use for Basic authorization.</p>"
}
},
"documentation":"<p>Contains the Basic authorization parameters for the connection.</p>"
},
"UpdateConnectionOAuthClientRequestParameters":{
"type":"structure",
"members":{
"ClientID":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The client ID to use for OAuth authorization.</p>"
},
"ClientSecret":{
"shape":"AuthHeaderParameters",
"documentation":"<p>The client secret assciated with the client ID to use for OAuth authorization.</p>"
}
},
"documentation":"<p>Contains the OAuth authorization parameters to use for the connection.</p>"
"documentation":"<p>A <code>UpdateConnectionOAuthClientRequestParameters</code> object that contains the client parameters to use for the connection when OAuth is specified as the authorization type.</p>"
},
"AuthorizationEndpoint":{
"shape":"HttpsEndpoint",
"documentation":"<p>The URL to the authorization endpoint when OAuth is specified as the authorization type.</p>"
},
"HttpMethod":{
"shape":"ConnectionOAuthHttpMethod",
"documentation":"<p>The method used to connect to the HTTP endpoint.</p>"
},
"OAuthHttpParameters":{
"shape":"ConnectionHttpParameters",
"documentation":"<p>The additional HTTP parameters used for the OAuth authorization request.</p>"
}
},
"documentation":"<p>Contains the OAuth request parameters to use for the connection.</p>"
},
"UpdateConnectionRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"ConnectionName",
"documentation":"<p>The name of the connection to update.</p>"
},
"Description":{
"shape":"ConnectionDescription",
"documentation":"<p>A description for the connection.</p>"
},
"AuthorizationType":{
"shape":"ConnectionAuthorizationType",
"documentation":"<p>The type of authorization to use for the connection.</p>"
},
"AuthParameters":{
"shape":"UpdateConnectionAuthRequestParameters",
"documentation":"<p>The authorization parameters to use for the connection.</p>"
}
}
},
"UpdateConnectionResponse":{
"type":"structure",
"members":{
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The ARN of the connection that was updated.</p>"
},
"ConnectionState":{
"shape":"ConnectionState",
"documentation":"<p>The state of the connection that was updated.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the connection was created.</p>"
},
"LastModifiedTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the connection was last modified.</p>"
},
"LastAuthorizedTime":{
"shape":"Timestamp",
"documentation":"<p>A time stamp for the time that the connection was last authorized.</p>"
"documentation":"<p>Amazon EventBridge helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:</p> <ul> <li> <p>Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.</p> </li> <li> <p>Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.</p> </li> <li> <p>Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.</p> </li> </ul> <p>For more information about the features of Amazon EventBridge, see the <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide\">Amazon EventBridge User Guide</a>.</p>"