Bedrock Agentcore Control  >  Operations  >  get_oauth2_credential_provider

get_oauth2_credential_provider

Operation

get_oauth2_credential_provider async

get_oauth2_credential_provider(input: GetOauth2CredentialProviderInput, plugins: list[Plugin] | None = None) -> GetOauth2CredentialProviderOutput

Retrieves information about an OAuth2 credential provider.

Parameters:

Name	Type	Description	Default
input	GetOauth2CredentialProviderInput	An instance of GetOauth2CredentialProviderInput.	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
GetOauth2CredentialProviderOutput	An instance of GetOauth2CredentialProviderOutput.

Input

GetOauth2CredentialProviderInput dataclass

Dataclass for GetOauth2CredentialProviderInput structure.

Attributes

name class-attribute instance-attribute

name: str | None = None

The name of the OAuth2 credential provider to retrieve.

Output

GetOauth2CredentialProviderOutput dataclass

Dataclass for GetOauth2CredentialProviderOutput 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

ARN of the credential provider requested.

credential_provider_vendor instance-attribute

credential_provider_vendor: CredentialProviderVendorType

The vendor of the OAuth2 credential provider.

failure_reason class-attribute instance-attribute

failure_reason: str | None = None

The reason for failure if the OAuth2 credential provider is in a failed state.

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 OAuth2 credential provider.