EventBridge / Client / create_connection

create_connection#

EventBridge.Client.create_connection(**kwargs)#

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.

Request Syntax

response = 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'
        }
    }
)

Parameters:

Name (string) –
[REQUIRED]

The name for the connection to create.
Description (string) – A description for the connection to create.
AuthorizationType (string) –
[REQUIRED]

The type of authorization to use for the connection.

Note
OAUTH tokens are refreshed when a 401 or 407 response is returned.
AuthParameters (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 resource configuration for the resource endpoint.
InvocationConnectivityParameters (dict) –
For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

For more information, see Connecting to private resources 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 resource configuration for the resource endpoint.

Return type:

dict

Returns:

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.

Exceptions

EventBridge.Client.exceptions.ResourceAlreadyExistsException
EventBridge.Client.exceptions.LimitExceededException
EventBridge.Client.exceptions.ResourceNotFoundException
EventBridge.Client.exceptions.InternalException
EventBridge.Client.exceptions.AccessDeniedException
EventBridge.Client.exceptions.ThrottlingException