Skip to content

get_oauth2_credential_provider

Operation

get_oauth2_credential_provider

get_oauth2_credential_provider(request: GetOauth2CredentialProviderInput | GetOauth2CredentialProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOauth2CredentialProviderInputDict]) -> GetOauth2CredentialProviderOutput

Retrieves information about an OAuth2 credential provider.

Parameters:

Name Type Description Default
request GetOauth2CredentialProviderInput | GetOauth2CredentialProviderInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetOauth2CredentialProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOauth2CredentialProviderOutput

An instance of GetOauth2CredentialProviderOutput.

get_oauth2_credential_provider async

get_oauth2_credential_provider(request: GetOauth2CredentialProviderInput | GetOauth2CredentialProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOauth2CredentialProviderInputDict]) -> GetOauth2CredentialProviderOutput

Retrieves information about an OAuth2 credential provider.

Parameters:

Name Type Description Default
request GetOauth2CredentialProviderInput | GetOauth2CredentialProviderInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetOauth2CredentialProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOauth2CredentialProviderOutput

An instance of GetOauth2CredentialProviderOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetOauth2CredentialProviderInputDict

Bases: TypedDict

Dictionary form of GetOauth2CredentialProviderInput.

Attributes

name instance-attribute
name: Required[str]

The name of the OAuth2 credential provider to retrieve.

GetOauth2CredentialProviderInput dataclass

Bases: _SerdeShape

Dataclass for GetOauth2CredentialProviderInput structure.

Attributes

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

The name of the OAuth2 credential provider to retrieve.

Output

GetOauth2CredentialProviderOutput dataclass

Bases: _SerdeShape

Dataclass for GetOauth2CredentialProviderOutput structure.

Attributes

callback_url class-attribute instance-attribute
callback_url: str | 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 = ...

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: str | 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: str

The vendor of the OAuth2 credential provider.

failure_reason class-attribute instance-attribute
failure_reason: str | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute
status: str | None = ...

The current status of the OAuth2 credential provider.