EventBridge / Client / update_connection

update_connection#

EventBridge.Client.update_connection(**kwargs)#

Updates settings for a connection.

Request Syntax

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

Parameters:

Name (string) –
[REQUIRED]

The name of the connection to update.
Description (string) – A description for the connection.
AuthorizationType (string) – The type of authorization to use for the connection.
AuthParameters (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 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),
    '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.

Exceptions

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