Skip to content

describe_ipam_external_resource_verification_tokens

Operation

describe_ipam_external_resource_verification_tokens

Describe verification tokens.

A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

Parameters:

Name Type Description Default
request DescribeIpamExternalResourceVerificationTokensInput | DescribeIpamExternalResourceVerificationTokensInputDict | 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[DescribeIpamExternalResourceVerificationTokensInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamExternalResourceVerificationTokensOutput

An instance of DescribeIpamExternalResourceVerificationTokensOutput.

describe_ipam_external_resource_verification_tokens async

Describe verification tokens.

A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

Parameters:

Name Type Description Default
request DescribeIpamExternalResourceVerificationTokensInput | DescribeIpamExternalResourceVerificationTokensInputDict | 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[DescribeIpamExternalResourceVerificationTokensInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamExternalResourceVerificationTokensOutput

An instance of DescribeIpamExternalResourceVerificationTokensOutput.

Input

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

DescribeIpamExternalResourceVerificationTokensInputDict

Bases: TypedDict

Dictionary form of DescribeIpamExternalResourceVerificationTokensInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters for the request. For more information about filtering, see Filtering CLI output.

Available filters:

  • ipam-arn

  • ipam-external-resource-verification-token-arn

  • ipam-external-resource-verification-token-id

  • ipam-id

  • ipam-region

  • state

  • status

  • token-name

  • token-value

ipam_external_resource_verification_token_ids instance-attribute
ipam_external_resource_verification_token_ids: Sequence[str] | None

Verification token IDs.

max_results instance-attribute
max_results: int | None

The maximum number of tokens to return in one page of results.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

DescribeIpamExternalResourceVerificationTokensInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamExternalResourceVerificationTokensInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters for the request. For more information about filtering, see Filtering CLI output.

Available filters:

  • ipam-arn

  • ipam-external-resource-verification-token-arn

  • ipam-external-resource-verification-token-id

  • ipam-id

  • ipam-region

  • state

  • status

  • token-name

  • token-value

ipam_external_resource_verification_token_ids class-attribute instance-attribute
ipam_external_resource_verification_token_ids: list[str] | None = ...

Verification token IDs.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of tokens to return in one page of results.

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

The token for the next page of results.

Output

DescribeIpamExternalResourceVerificationTokensOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamExternalResourceVerificationTokensOutput structure.

Attributes

ipam_external_resource_verification_tokens class-attribute instance-attribute
ipam_external_resource_verification_tokens: list[IpamExternalResourceVerificationToken] | None = ...

Verification tokens.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.