BedrockAgentCoreControlPlaneFrontingLayer / Client / update_oauth2_credential_provider

update_oauth2_credential_provider¶

BedrockAgentCoreControlPlaneFrontingLayer.Client.update_oauth2_credential_provider(**kwargs)¶

Updates an existing OAuth2 credential provider.

Request Syntax

response = client.update_oauth2_credential_provider(
    name='string',
    credentialProviderVendor='GoogleOauth2'|'GithubOauth2'|'SlackOauth2'|'SalesforceOauth2'|'MicrosoftOauth2'|'CustomOauth2',
    oauth2ProviderConfigInput={
        'customOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            },
            'clientId': 'string',
            'clientSecret': 'string'
        },
        'googleOauth2ProviderConfig': {
            'clientId': 'string',
            'clientSecret': 'string'
        },
        'githubOauth2ProviderConfig': {
            'clientId': 'string',
            'clientSecret': 'string'
        },
        'slackOauth2ProviderConfig': {
            'clientId': 'string',
            'clientSecret': 'string'
        },
        'salesforceOauth2ProviderConfig': {
            'clientId': 'string',
            'clientSecret': 'string'
        },
        'microsoftOauth2ProviderConfig': {
            'clientId': 'string',
            'clientSecret': 'string'
        }
    }
)

Parameters:

name (string) –
[REQUIRED]

The name of the OAuth2 credential provider to update.
credentialProviderVendor (string) –
[REQUIRED]

The vendor of the OAuth2 credential provider.
oauth2ProviderConfigInput (dict) –
[REQUIRED]

The configuration input for the OAuth2 provider.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: customOauth2ProviderConfig, googleOauth2ProviderConfig, githubOauth2ProviderConfig, slackOauth2ProviderConfig, salesforceOauth2ProviderConfig, microsoftOauth2ProviderConfig.
- customOauth2ProviderConfig (dict) –
  
  The configuration for a custom OAuth2 provider.
  - oauthDiscovery (dict) – [REQUIRED]
    
    The OAuth2 discovery information for the custom provider.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: discoveryUrl, authorizationServerMetadata.
    - discoveryUrl (string) –
      
      The discovery URL for the OAuth2 provider.
    - authorizationServerMetadata (dict) –
      
      The authorization server metadata for the OAuth2 provider.
      - issuer (string) – [REQUIRED]
        
        The issuer URL for the OAuth2 authorization server.
      - authorizationEndpoint (string) – [REQUIRED]
        
        The authorization endpoint URL for the OAuth2 authorization server.
      - tokenEndpoint (string) – [REQUIRED]
        
        The token endpoint URL for the OAuth2 authorization server.
      - responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
  - clientId (string) – [REQUIRED]
    
    The client ID for the custom OAuth2 provider.
  - clientSecret (string) – [REQUIRED]
    
    The client secret for the custom OAuth2 provider.
- googleOauth2ProviderConfig (dict) –
  
  The configuration for a Google OAuth2 provider.
  - clientId (string) – [REQUIRED]
    
    The client ID for the Google OAuth2 provider.
  - clientSecret (string) – [REQUIRED]
    
    The client secret for the Google OAuth2 provider.
- githubOauth2ProviderConfig (dict) –
  
  The configuration for a GitHub OAuth2 provider.
  - clientId (string) – [REQUIRED]
    
    The client ID for the GitHub OAuth2 provider.
  - clientSecret (string) – [REQUIRED]
    
    The client secret for the GitHub OAuth2 provider.
- slackOauth2ProviderConfig (dict) –
  
  The configuration for a Slack OAuth2 provider.
  - clientId (string) – [REQUIRED]
    
    The client ID for the Slack OAuth2 provider.
  - clientSecret (string) – [REQUIRED]
    
    The client secret for the Slack OAuth2 provider.
- salesforceOauth2ProviderConfig (dict) –
  
  The configuration for a Salesforce OAuth2 provider.
  - clientId (string) – [REQUIRED]
    
    The client ID for the Salesforce OAuth2 provider.
  - clientSecret (string) – [REQUIRED]
    
    The client secret for the Salesforce OAuth2 provider.
- microsoftOauth2ProviderConfig (dict) –
  
  The configuration for a Microsoft OAuth2 provider.
  - clientId (string) – [REQUIRED]
    
    The client ID for the Microsoft OAuth2 provider.
  - clientSecret (string) – [REQUIRED]
    
    The client secret for the Microsoft OAuth2 provider.

Return type:

dict

Returns:

Response Syntax

{
    'clientSecretArn': {
        'secretArn': 'string'
    },
    'name': 'string',
    'credentialProviderVendor': 'GoogleOauth2'|'GithubOauth2'|'SlackOauth2'|'SalesforceOauth2'|'MicrosoftOauth2'|'CustomOauth2',
    'credentialProviderArn': 'string',
    'oauth2ProviderConfigOutput': {
        'customOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            }
        },
        'googleOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            }
        },
        'githubOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            }
        },
        'slackOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            }
        },
        'salesforceOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            }
        },
        'microsoftOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ]
                }
            }
        }
    },
    'createdTime': datetime(2015, 1, 1),
    'lastUpdatedTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- clientSecretArn (dict) –
  
  The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
  - secretArn (string) –
    
    The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
- name (string) –
  
  The name of the OAuth2 credential provider.
- credentialProviderVendor (string) –
  
  The vendor of the OAuth2 credential provider.
- credentialProviderArn (string) –
  
  The Amazon Resource Name (ARN) of the OAuth2 credential provider.
- oauth2ProviderConfigOutput (dict) –
  
  The configuration output for the OAuth2 provider.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: customOauth2ProviderConfig, googleOauth2ProviderConfig, githubOauth2ProviderConfig, slackOauth2ProviderConfig, salesforceOauth2ProviderConfig, microsoftOauth2ProviderConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - customOauth2ProviderConfig (dict) –
    
    The output configuration for a custom OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the custom provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
  - googleOauth2ProviderConfig (dict) –
    
    The output configuration for a Google OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Google provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
  - githubOauth2ProviderConfig (dict) –
    
    The output configuration for a GitHub OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the GitHub provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
  - slackOauth2ProviderConfig (dict) –
    
    The output configuration for a Slack OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Slack provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
  - salesforceOauth2ProviderConfig (dict) –
    
    The output configuration for a Salesforce OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Salesforce provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
  - microsoftOauth2ProviderConfig (dict) –
    
    The output configuration for a Microsoft OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Microsoft provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
- createdTime (datetime) –
  
  The timestamp when the OAuth2 credential provider was created.
- lastUpdatedTime (datetime) –
  
  The timestamp when the OAuth2 credential provider was last updated.

Exceptions

BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.UnauthorizedException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ValidationException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.AccessDeniedException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ConflictException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.DecryptionFailure
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ThrottlingException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.InternalServerException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.EncryptionFailure