"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> <note> <p>This operation is performed by AWS customers, not by SaaS partners.</p> </note>"
},
"CreateEventBus":{
"name":"CreateEventBus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEventBusRequest"},
"output":{"shape":"CreateEventBusResponse"},
"errors":[
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InternalException"},
{"shape":"ConcurrentModificationException"},
{"shape":"LimitExceededException"}
],
"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 own custom applications and services, or it can be a partner event bus which can be matched to a partner event source.</p> <note> <p>This operation is used by AWS customers, not by SaaS partners.</p> </note>"
"documentation":"<p>Called by an SaaS partner to create a partner event source.</p> <note> <p>This operation is not used by AWS customers.</p> </note> <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 in 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>aws.partner/<i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i> </code> </p> <ul> <li> <p> <i>partner_name</i> is determined during partner registration and identifies the partner to AWS customers.</p> </li> <li> <p>For <i>event_namespace</i>, we recommend that partners use a string that identifies the AWS customer within the partner's system. This should not be the customer's AWS account ID.</p> </li> <li> <p> <i>event_name</i> is determined by the partner, and should uniquely identify an event-generating resource within the partner system. This should help AWS customers decide whether to create an event bus to receive these events.</p> </li> </ul>"
},
"DeactivateEventSource":{
"name":"DeactivateEventSource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeactivateEventSourceRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InternalException"}
],
"documentation":"<p>An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't deleted. </p> <p>When you deactivate a partner event source, the source goes into <code>PENDING</code> state. If it remains in <code>PENDING</code> state for more than two weeks, it's deleted.</p> <p>To activate a deactivated partner event source, use <a>ActivateEventSource</a>.</p>"
},
"DeleteEventBus":{
"name":"DeleteEventBus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEventBusRequest"},
"errors":[
{"shape":"InternalException"}
],
"documentation":"<p>Deletes the specified custom event bus or partner event bus. All rules associated with this event bus are also deleted. You can't delete your account's default event bus.</p> <note> <p>This operation is performed by AWS customers, not by SaaS partners.</p> </note>"
"documentation":"<p>This operation is used by SaaS partners to delete a partner event source. AWS customers don't use this operation.</p> <p>When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes <code>DELETED</code>.</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're sure that the other service isn't 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>"
},
"DescribeEventSource":{
"name":"DescribeEventSource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventSourceRequest"},
"output":{"shape":"DescribeEventSourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalException"}
],
"documentation":"<p>This operation lists details about a partner event source that is shared with your account.</p> <note> <p>This operation is run by AWS customers, not by SaaS partners.</p> </note>"
"documentation":"<p>An SaaS partner can use this operation to list details about a partner event source that they have created.</p> <note> <p>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> </note>"
"documentation":"<p>Describes the specified rule.</p> <p> <code>DescribeRule</code> doesn't 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 doesn't 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>"
},
"ListEventBuses":{
"name":"ListEventBuses",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEventBusesRequest"},
"output":{"shape":"ListEventBusesResponse"},
"errors":[
{"shape":"InternalException"}
],
"documentation":"<p>Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.</p> <note> <p>This operation is run by AWS customers, not by SaaS partners.</p> </note>"
},
"ListEventSources":{
"name":"ListEventSources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEventSourcesRequest"},
"output":{"shape":"ListEventSourcesResponse"},
"errors":[
{"shape":"InternalException"}
],
"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> <note> <p>This operation is run by AWS customers, not by SaaS partners.</p> </note>"
"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.</p> <note> <p>This operation is used by SaaS partners, not by AWS customers.</p> </note>"
"documentation":"<p>An SaaS partner can use this operation to list all the partner event source names that they have created.</p> <note> <p>This operation is not used by AWS customers.</p> </note>"
"documentation":"<p>Lists your EventBridge rules. You can either list all the rules or provide a prefix to match to the rule names.</p> <p> <code>ListRules</code> doesn't list the targets of a rule. To see the targets associated with a rule, use <a>ListTargetsByRule</a>.</p>"
"documentation":"<p>Sends custom events to EventBridge so that they can be matched to rules. These events can be from your custom applications and services.</p>"
},
"PutPartnerEvents":{
"name":"PutPartnerEvents",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutPartnerEventsRequest"},
"output":{"shape":"PutPartnerEventsResponse"},
"errors":[
{"shape":"InternalException"}
],
"documentation":"<p>This is used by SaaS partners to write events to a customer's partner event bus.</p> <note> <p>AWS customers do not use this operation. Instead, AWS customers can use <a>PutEvents</a> to write custom events from their own applications to an event bus.</p> </note>"
"documentation":"<p>Running <code>PutPermission</code> permits the specified AWS account or AWS organization to put events to the specified <i>event bus</i>. 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 a rule with your account's event bus as a target.</p> <p>To enable multiple AWS accounts to put events to an 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 an event bus can't 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're 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 aren't kept. Instead, they're 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 <code>EventPattern</code> or <code>ScheduleExpression</code>. Rules with <code>EventPatterns</code> are triggered when a matching event is observed. Rules with <code>ScheduleExpressions</code> self-trigger based on the given schedule. A rule can have both an <code>EventPattern</code> and a <code>ScheduleExpression</code>, 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 <code>:</code> or <code>/</code> 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 that you want to match.</p> <p>In EventBridge, you could 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 you don't write the rule 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 don't refire 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're 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 in EventBridge:</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> </ul> <p>Creating rules with built-in targets is supported only on 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 needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, 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 isn't charged. For more information, see <a href=\"https://aws.amazon.com/eventbridge/pricing/\">Amazon EventBridge Pricing</a>.</p> <p>If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a <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><code>Input</code>,<code>InputPath</code>,and<code>InputTransformer</code>aremutuallyexclusiveandoptionalparametersofatarget.Whenaruleistriggeredduetoamatchedevent:</p><ul><li><p>Ifnoneofthefollowingargumentsarespecifiedforatarget,theentireeventispassedtothetargetinJSONformat(unlessthetargetisAmazonEC2RunCommandorAmazonECStask,inwhichcasenothingfromtheeventispassedtothetarget).</p></li><li><p>If<code>Input</code>isspe
"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>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 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 rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, 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 <code>:</code> or <code>/</code> 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 that you want to match.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalException"},
{"shape":"ConcurrentModificationException"},
{"shape":"ManagedRuleException"}
],
"documentation":"<p>Removes one or more tags from the specified EventBridge resource. In EventBridge, rules 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 don't 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 that you can use to limit the event bus permissions that you're 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. The following is an example value for <code>Condition</code>:</p> <p> <code>'{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\": \"o-1234567890\"}'</code> </p>"
},
"CreateEventBusRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"EventBusName",
"documentation":"<p>The name of the new event bus. </p> <p>The names of custom event buses can't contain the <code>/</code> character. You can't use the name <code>default</code> for a custom event bus because 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. This name will include the <code>/</code> character.</p>"
},
"EventSourceName":{
"shape":"EventSourceName",
"documentation":"<p>If you're creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.</p>"
}
}
},
"CreateEventBusResponse":{
"type":"structure",
"members":{
"EventBusArn":{
"shape":"String",
"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>"
},
"Account":{
"shape":"AccountId",
"documentation":"<p>The AWS account ID of the customer who is permitted to create a matching partner event bus for this partner event source.</p>"
}
}
},
"CreatePartnerEventSourceResponse":{
"type":"structure",
"members":{
"EventSourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the partner event source.</p>"
}
}
},
"DeactivateEventSourceRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"EventSourceName",
"documentation":"<p>The name of the partner event source to deactivate.</p>"
}
}
},
"DeleteEventBusRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"EventBusName",
"documentation":"<p>The name of the event bus to delete.</p>"
}
}
},
"DeletePartnerEventSourceRequest":{
"type":"structure",
"required":[
"Name",
"Account"
],
"members":{
"Name":{
"shape":"EventSourceName",
"documentation":"<p>The name of the event source to delete.</p>"
},
"Account":{
"shape":"AccountId",
"documentation":"<p>The AWS account ID of the AWS customer that the event source was created for.</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 name of the partner event source to display the details of.</p>"
}
}
},
"DescribeEventSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"String",
"documentation":"<p>The ARN of the partner event source.</p>"
},
"CreatedBy":{
"shape":"String",
"documentation":"<p>The name of the SaaS partner that created the event source.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the event source was created.</p>"
},
"ExpirationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the event source will expire if you don't create a matching event bus.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of the partner event source.</p>"
},
"State":{
"shape":"EventSourceState",
"documentation":"<p>The state of the event source. If it's <code>ACTIVE</code>, you have already created a matching event bus for this event source, and that event bus is active. If it's <code>PENDING</code>, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's <code>DELETED</code>, you have created a matching event bus, but the event source has since been deleted.</p>"
}
}
},
"DescribePartnerEventSourceRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"EventSourceName",
"documentation":"<p>The name of the event source to display.</p>"
}
}
},
"DescribePartnerEventSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"String",
"documentation":"<p>The ARN of the event source.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of the event source.</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\">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>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 doesn't 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 ARN of the event source.</p>"
},
"CreatedBy":{
"shape":"String",
"documentation":"<p>The name of the partner that created the event source.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the event source was created.</p>"
},
"ExpirationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the event source will expire if the AWS account doesn't create a matching event bus for it.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of the event source.</p>"
},
"State":{
"shape":"EventSourceState",
"documentation":"<p>The state of the event source. If it's <code>ACTIVE</code>, you have already created a matching event bus for this event source, and that event bus is active. If it's <code>PENDING</code>, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's <code>DELETED</code>, 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>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 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 10 key-value pairs. You must use JSON dot notation, not bracket notation.</p> <p>The keys can't start with <code>\"AWS\"</code>.</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 can't be used as an object key</p> </li> <li> <p>Object values can't include quote marks</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>"
"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 that the event goes to. If you don't include this parameter, the default is to use the <code>eventId</code> as the partition key.</p>"
"documentation":"<p>Specifying this limits the results to only those event buses with names that start with the specified prefix.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>"
},
"Limit":{
"shape":"LimitMax100",
"documentation":"<p>Specifying this limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> that you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListEventBusesResponse":{
"type":"structure",
"members":{
"EventBuses":{
"shape":"EventBusList",
"documentation":"<p>This list of event buses.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListEventSourcesRequest":{
"type":"structure",
"members":{
"NamePrefix":{
"shape":"EventSourceNamePrefix",
"documentation":"<p>Specifying this limits the results to only those partner event sources with names that start with the specified prefix.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>"
},
"Limit":{
"shape":"LimitMax100",
"documentation":"<p>Specifying this limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> that you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListEventSourcesResponse":{
"type":"structure",
"members":{
"EventSources":{
"shape":"EventSourceList",
"documentation":"<p>The list of event sources.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListPartnerEventSourceAccountsRequest":{
"type":"structure",
"required":["EventSourceName"],
"members":{
"EventSourceName":{
"shape":"EventSourceName",
"documentation":"<p>The name of the partner event source to display account information about.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned by a previous call to this operation. Specifying this retrieves the next set of results.</p>"
},
"Limit":{
"shape":"LimitMax100",
"documentation":"<p>Specifying this limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> that you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListPartnerEventSourceAccountsResponse":{
"type":"structure",
"members":{
"PartnerEventSourceAccounts":{
"shape":"PartnerEventSourceAccountList",
"documentation":"<p>The list of partner event sources returned by the operation.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListPartnerEventSourcesRequest":{
"type":"structure",
"required":["NamePrefix"],
"members":{
"NamePrefix":{
"shape":"PartnerEventSourceNamePrefix",
"documentation":"<p>If you specify this, the results are limited to only those partner event sources that start with the string you specify.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned by a previous call to this operation. Specifying this retrieves the next set of results.</p>"
},
"Limit":{
"shape":"LimitMax100",
"documentation":"<p>pecifying this limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> that you can use in a subsequent operation to retrieve the next set of results.</p>"
}
}
},
"ListPartnerEventSourcesResponse":{
"type":"structure",
"members":{
"PartnerEventSources":{
"shape":"PartnerEventSourceList",
"documentation":"<p>The list of partner event sources returned by the operation.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token you can use in a subsequent operation to retrieve the next set of results.</p>"
"documentation":"<p>An AWS service created this rule on behalf of your account. That service manages it. 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 can't 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>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the event source was created.</p>"
},
"ExpirationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the event source will expire if the AWS account doesn't create a matching event bus for it.</p>"
},
"State":{
"shape":"EventSourceState",
"documentation":"<p>The state of the event source. If it's <code>ACTIVE</code>, you have already created a matching event bus for this event source, and that event bus is active. If it's <code>PENDING</code>, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's <code>DELETED</code>, you have created a matching event bus, but the event source has since been deleted.</p>"
}
},
"documentation":"<p>The AWS account that a partner event source has been offered to.</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 timestamp of the event, per <a href=\"https://www.rfc-editor.org/rfc/rfc3339.txt\">RFC3339</a>. If no timestamp is provided, the timestamp of the <a>PutEvents</a> call is used.</p>"
"documentation":"<p>AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including zero, can be present.</p>"
"documentation":"<p>A valid JSON object. There is no other schema imposed. The JSON object can contain fields and nested subobjects.</p> <p>This field is required.</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), that the event primarily concerns. Any number, including zero, can be present.</p>"
"documentation":"<p>A valid JSON object. There is no other schema imposed. The JSON object can contain fields and nested subobjects. This field is required.</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 might 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 to receive events from. Rules that have an account field match events sent only from accounts that are listed in the rule's <code>account</code> field.</p>"
"documentation":"<p>An identifier string for the external account that you're 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 that must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>"
"documentation":"<p>The name of the rule that you're creating or updating.</p> <p>A rule can't have the same name as another rule in the same Region or on the same event bus.</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\">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>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 aren't 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 event pattern of the rule. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\">Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"
"documentation":"<p>If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.</p>"
},
"EventBusName":{
"shape":"EventBusName",
"documentation":"<p>The event bus associated with the rule.</p>"
"documentation":"<p>Currently, we support including only one <code>RunCommandTarget</code> block, which specifies either an array of <code>InstanceIds</code> or a tag.</p>"
"documentation":"<p>This parameter contains the criteria (either <code>InstanceIds</code> 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 can specify multiple values.</p>"
"documentation":"<p>A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The value for the specified tag key.</p>"
}
},
"documentation":"<p>A key-value pair associated with an AWS resource. In EventBridge, rules support tagging.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"Arn",
"documentation":"<p>The ARN of the rule that you're adding tags to.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The list of key-value pairs to associate with the rule.</p>"
"documentation":"<p>A name for the target. Use a string that will help you identify the target. Each target associated with a rule must have an <code>Id</code> unique for that rule.</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 that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't 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>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're 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, 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\">Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</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>"
