2025/04/16 - Amazon EventBridge - 3 updated api methods
Changes Adding support for KmsKeyIdentifer in CreateConnection, UpdateConnection and DescribeConnection APIs
{'KmsKeyIdentifier': 'string'}
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide.
See also: AWS API Documentation
Request Syntax
client.create_connection(
Name='string',
Description='string',
AuthorizationType='BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
AuthParameters={
'BasicAuthParameters': {
'Username': 'string',
'Password': 'string'
},
'OAuthParameters': {
'ClientParameters': {
'ClientID': 'string',
'ClientSecret': 'string'
},
'AuthorizationEndpoint': 'string',
'HttpMethod': 'GET'|'POST'|'PUT',
'OAuthHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'ApiKeyAuthParameters': {
'ApiKeyName': 'string',
'ApiKeyValue': 'string'
},
'InvocationHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
},
'ConnectivityParameters': {
'ResourceParameters': {
'ResourceConfigurationArn': 'string'
}
}
},
InvocationConnectivityParameters={
'ResourceParameters': {
'ResourceConfigurationArn': 'string'
}
},
KmsKeyIdentifier='string'
)
string
[REQUIRED]
The name for the connection to create.
string
A description for the connection to create.
string
[REQUIRED]
The type of authorization to use for the connection.
dict
[REQUIRED]
The authorization parameters to use to authorize with the endpoint.
You must include only authorization parameters for the AuthorizationType you specify.
BasicAuthParameters (dict) --
The Basic authorization parameters to use for the connection.
Username (string) -- [REQUIRED]
The user name to use for Basic authorization.
Password (string) -- [REQUIRED]
The password associated with the user name to use for Basic authorization.
OAuthParameters (dict) --
The OAuth authorization parameters to use for the connection.
ClientParameters (dict) -- [REQUIRED]
The client parameters for OAuth authorization.
ClientID (string) -- [REQUIRED]
The client ID to use for OAuth authorization for the connection.
ClientSecret (string) -- [REQUIRED]
The client secret associated with the client ID to use for OAuth authorization for the connection.
AuthorizationEndpoint (string) -- [REQUIRED]
The URL to the authorization endpoint when OAuth is specified as the authorization type.
HttpMethod (string) -- [REQUIRED]
The method to use for the authorization request.
OAuthHttpParameters (dict) --
Details about the additional parameters to use for the connection.
HeaderParameters (list) --
Any additional header parameters for the connection.
(dict) --
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is a secret.
QueryStringParameters (list) --
Any additional query string parameters for the connection.
(dict) --
Any 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.
Key (string) --
The key for a query string parameter.
Value (string) --
The value associated with the key for the query string parameter.
IsValueSecret (boolean) --
Specifies whether the value is secret.
BodyParameters (list) --
Any additional body string parameters for the connection.
(dict) --
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is secret.
ApiKeyAuthParameters (dict) --
The API key authorization parameters to use for the connection.
ApiKeyName (string) -- [REQUIRED]
The name of the API key to use for authorization.
ApiKeyValue (string) -- [REQUIRED]
The value for the API key to use for authorization.
InvocationHttpParameters (dict) --
The API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters, including query strings, the parameters added for the connection take precedence.
HeaderParameters (list) --
Any additional header parameters for the connection.
(dict) --
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is a secret.
QueryStringParameters (list) --
Any additional query string parameters for the connection.
(dict) --
Any 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.
Key (string) --
The key for a query string parameter.
Value (string) --
The value associated with the key for the query string parameter.
IsValueSecret (boolean) --
Specifies whether the value is secret.
BodyParameters (list) --
Any additional body string parameters for the connection.
(dict) --
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is secret.
ConnectivityParameters (dict) --
If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.
For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .
ResourceParameters (dict) -- [REQUIRED]
The parameters for EventBridge to use when invoking the resource endpoint.
ResourceConfigurationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
dict
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
ResourceParameters (dict) -- [REQUIRED]
The parameters for EventBridge to use when invoking the resource endpoint.
ResourceConfigurationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
string
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
dict
Response Syntax
{
'ConnectionArn': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ConnectionArn (string) --
The ARN of the connection that was created by the request.
ConnectionState (string) --
The state of the connection that was created by the request.
CreationTime (datetime) --
A time stamp for the time that the connection was created.
LastModifiedTime (datetime) --
A time stamp for the time that the connection was last updated.
{'KmsKeyIdentifier': 'string'}
Retrieves details about a connection.
See also: AWS API Documentation
Request Syntax
client.describe_connection(
Name='string'
)
string
[REQUIRED]
The name of the connection to retrieve.
dict
Response Syntax
{
'ConnectionArn': 'string',
'Name': 'string',
'Description': 'string',
'InvocationConnectivityParameters': {
'ResourceParameters': {
'ResourceConfigurationArn': 'string',
'ResourceAssociationArn': 'string'
}
},
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY',
'StateReason': 'string',
'AuthorizationType': 'BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
'SecretArn': 'string',
'KmsKeyIdentifier': 'string',
'AuthParameters': {
'BasicAuthParameters': {
'Username': 'string'
},
'OAuthParameters': {
'ClientParameters': {
'ClientID': 'string'
},
'AuthorizationEndpoint': 'string',
'HttpMethod': 'GET'|'POST'|'PUT',
'OAuthHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'ApiKeyAuthParameters': {
'ApiKeyName': 'string'
},
'InvocationHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
},
'ConnectivityParameters': {
'ResourceParameters': {
'ResourceConfigurationArn': 'string',
'ResourceAssociationArn': 'string'
}
}
},
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ConnectionArn (string) --
The ARN of the connection retrieved.
Name (string) --
The name of the connection retrieved.
Description (string) --
The description for the connection retrieved.
InvocationConnectivityParameters (dict) --
For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
ResourceParameters (dict) --
The parameters for EventBridge to use when invoking the resource endpoint.
ResourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the resource configuration for the private API.
ResourceAssociationArn (string) --
For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
For more information, see Managing service network resource associations for connections in the Amazon EventBridge User Guide .
ConnectionState (string) --
The state of the connection retrieved.
StateReason (string) --
The reason that the connection is in the current connection state.
AuthorizationType (string) --
The type of authorization specified for the connection.
SecretArn (string) --
The ARN of the secret created from the authorization parameters specified for the connection.
KmsKeyIdentifier (string) --
The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.
For more information, see Encrypting connections in the Amazon EventBridge User Guide.
AuthParameters (dict) --
The parameters to use for authorization for the connection.
BasicAuthParameters (dict) --
The authorization parameters for Basic authorization.
Username (string) --
The user name to use for Basic authorization.
OAuthParameters (dict) --
The OAuth parameters to use for authorization.
ClientParameters (dict) --
Details about the client parameters returned when OAuth is specified as the authorization type.
ClientID (string) --
The client ID associated with the response to the connection request.
AuthorizationEndpoint (string) --
The URL to the HTTP endpoint that authorized the request.
HttpMethod (string) --
The method used to connect to the HTTP endpoint.
OAuthHttpParameters (dict) --
The additional HTTP parameters used for the OAuth authorization request.
HeaderParameters (list) --
Any additional header parameters for the connection.
(dict) --
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is a secret.
QueryStringParameters (list) --
Any additional query string parameters for the connection.
(dict) --
Any 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.
Key (string) --
The key for a query string parameter.
Value (string) --
The value associated with the key for the query string parameter.
IsValueSecret (boolean) --
Specifies whether the value is secret.
BodyParameters (list) --
Any additional body string parameters for the connection.
(dict) --
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is secret.
ApiKeyAuthParameters (dict) --
The API Key parameters to use for authorization.
ApiKeyName (string) --
The name of the header to use for the APIKeyValue used for authorization.
InvocationHttpParameters (dict) --
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
HeaderParameters (list) --
Any additional header parameters for the connection.
(dict) --
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is a secret.
QueryStringParameters (list) --
Any additional query string parameters for the connection.
(dict) --
Any 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.
Key (string) --
The key for a query string parameter.
Value (string) --
The value associated with the key for the query string parameter.
IsValueSecret (boolean) --
Specifies whether the value is secret.
BodyParameters (list) --
Any additional body string parameters for the connection.
(dict) --
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is secret.
ConnectivityParameters (dict) --
For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.
For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .
ResourceParameters (dict) --
The parameters for EventBridge to use when invoking the resource endpoint.
ResourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the resource configuration for the private API.
ResourceAssociationArn (string) --
For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
For more information, see Managing service network resource associations for connections in the Amazon EventBridge User Guide .
CreationTime (datetime) --
A time stamp for the time that the connection was created.
LastModifiedTime (datetime) --
A time stamp for the time that the connection was last modified.
LastAuthorizedTime (datetime) --
A time stamp for the time that the connection was last authorized.
{'KmsKeyIdentifier': 'string'}
Updates settings for a connection.
See also: AWS API Documentation
Request Syntax
client.update_connection(
Name='string',
Description='string',
AuthorizationType='BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
AuthParameters={
'BasicAuthParameters': {
'Username': 'string',
'Password': 'string'
},
'OAuthParameters': {
'ClientParameters': {
'ClientID': 'string',
'ClientSecret': 'string'
},
'AuthorizationEndpoint': 'string',
'HttpMethod': 'GET'|'POST'|'PUT',
'OAuthHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'ApiKeyAuthParameters': {
'ApiKeyName': 'string',
'ApiKeyValue': 'string'
},
'InvocationHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
},
'ConnectivityParameters': {
'ResourceParameters': {
'ResourceConfigurationArn': 'string'
}
}
},
InvocationConnectivityParameters={
'ResourceParameters': {
'ResourceConfigurationArn': 'string'
}
},
KmsKeyIdentifier='string'
)
string
[REQUIRED]
The name of the connection to update.
string
A description for the connection.
string
The type of authorization to use for the connection.
dict
The authorization parameters to use for the connection.
BasicAuthParameters (dict) --
The authorization parameters for Basic authorization.
Username (string) --
The user name to use for Basic authorization.
Password (string) --
The password associated with the user name to use for Basic authorization.
OAuthParameters (dict) --
The authorization parameters for OAuth authorization.
ClientParameters (dict) --
The client parameters to use for the connection when OAuth is specified as the authorization type.
ClientID (string) --
The client ID to use for OAuth authorization.
ClientSecret (string) --
The client secret assciated with the client ID to use for OAuth authorization.
AuthorizationEndpoint (string) --
The URL to the authorization endpoint when OAuth is specified as the authorization type.
HttpMethod (string) --
The method used to connect to the HTTP endpoint.
OAuthHttpParameters (dict) --
The additional HTTP parameters used for the OAuth authorization request.
HeaderParameters (list) --
Any additional header parameters for the connection.
(dict) --
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is a secret.
QueryStringParameters (list) --
Any additional query string parameters for the connection.
(dict) --
Any 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.
Key (string) --
The key for a query string parameter.
Value (string) --
The value associated with the key for the query string parameter.
IsValueSecret (boolean) --
Specifies whether the value is secret.
BodyParameters (list) --
Any additional body string parameters for the connection.
(dict) --
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is secret.
ApiKeyAuthParameters (dict) --
The authorization parameters for API key authorization.
ApiKeyName (string) --
The name of the API key to use for authorization.
ApiKeyValue (string) --
The value associated with the API key to use for authorization.
InvocationHttpParameters (dict) --
The additional parameters to use for the connection.
HeaderParameters (list) --
Any additional header parameters for the connection.
(dict) --
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is a secret.
QueryStringParameters (list) --
Any additional query string parameters for the connection.
(dict) --
Any 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.
Key (string) --
The key for a query string parameter.
Value (string) --
The value associated with the key for the query string parameter.
IsValueSecret (boolean) --
Specifies whether the value is secret.
BodyParameters (list) --
Any additional body string parameters for the connection.
(dict) --
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
Key (string) --
The key for the parameter.
Value (string) --
The value associated with the key.
IsValueSecret (boolean) --
Specifies whether the value is secret.
ConnectivityParameters (dict) --
If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.
For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .
ResourceParameters (dict) -- [REQUIRED]
The parameters for EventBridge to use when invoking the resource endpoint.
ResourceConfigurationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
dict
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
ResourceParameters (dict) -- [REQUIRED]
The parameters for EventBridge to use when invoking the resource endpoint.
ResourceConfigurationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
string
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
dict
Response Syntax
{
'ConnectionArn': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ConnectionArn (string) --
The ARN of the connection that was updated.
ConnectionState (string) --
The state of the connection that was updated.
CreationTime (datetime) --
A time stamp for the time that the connection was created.
LastModifiedTime (datetime) --
A time stamp for the time that the connection was last modified.
LastAuthorizedTime (datetime) --
A time stamp for the time that the connection was last authorized.