Skip to content

Bedrock Agentcore Control  >  Operations  >  update_oauth2_credential_provider

update_oauth2_credential_provider

Operation

update_oauth2_credential_provider async

update_oauth2_credential_provider(input: UpdateOauth2CredentialProviderInput, plugins: list[Plugin] | None = None) -> UpdateOauth2CredentialProviderOutput

Updates an existing OAuth2 credential provider.

Parameters:

Name Type Description Default
input UpdateOauth2CredentialProviderInput

An instance of UpdateOauth2CredentialProviderInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
UpdateOauth2CredentialProviderOutput

An instance of UpdateOauth2CredentialProviderOutput.

Input

UpdateOauth2CredentialProviderInput dataclass

Dataclass for UpdateOauth2CredentialProviderInput structure.

Attributes

credential_provider_vendor class-attribute instance-attribute
credential_provider_vendor: CredentialProviderVendorType | None = None

The vendor of the OAuth2 credential provider.

name class-attribute instance-attribute
name: str | None = None

The name of the OAuth2 credential provider to update.

oauth2_provider_config_input class-attribute instance-attribute
oauth2_provider_config_input: Oauth2ProviderConfigInput | None = None

The configuration input for the OAuth2 provider.

Output

UpdateOauth2CredentialProviderOutput dataclass

Dataclass for UpdateOauth2CredentialProviderOutput structure.

Attributes

callback_url class-attribute instance-attribute
callback_url: str | None = None

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

client_secret_arn instance-attribute
client_secret_arn: Secret

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

client_secret_json_key class-attribute instance-attribute
client_secret_json_key: str | None = None

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

client_secret_source class-attribute instance-attribute
client_secret_source: SecretSourceType | None = None

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

created_time instance-attribute
created_time: datetime

The timestamp when the OAuth2 credential provider was created.

credential_provider_arn instance-attribute
credential_provider_arn: str

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

credential_provider_vendor instance-attribute
credential_provider_vendor: CredentialProviderVendorType

The vendor of the OAuth2 credential provider.

last_updated_time instance-attribute
last_updated_time: datetime

The timestamp when the OAuth2 credential provider was last updated.

name instance-attribute
name: str

The name of the OAuth2 credential provider.

oauth2_provider_config_output instance-attribute
oauth2_provider_config_output: Oauth2ProviderConfigOutput

The configuration output for the OAuth2 provider.

status class-attribute instance-attribute
status: Status | None = None

The current status of the updated OAuth2 credential provider.