EC2 / Client / describe_ipam_external_resource_verification_tokens

describe_ipam_external_resource_verification_tokens

EC2.Client.describe_ipam_external_resource_verification_tokens(**kwargs)

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).

See also: AWS API Documentation

Request Syntax

response = client.describe_ipam_external_resource_verification_tokens(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123,
    IpamExternalResourceVerificationTokenIds=[
        'string',
    ]
)

Parameters:

• DryRun (boolean) – 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 (list) –

  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

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• NextToken (string) – The token for the next page of results.

• MaxResults (integer) – The maximum number of tokens to return in one page of results.

• IpamExternalResourceVerificationTokenIds (list) –

  Verification token IDs.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'IpamExternalResourceVerificationTokens': [
        {
            'IpamExternalResourceVerificationTokenId': 'string',
            'IpamExternalResourceVerificationTokenArn': 'string',
            'IpamId': 'string',
            'IpamArn': 'string',
            'IpamRegion': 'string',
            'TokenValue': 'string',
            'TokenName': 'string',
            'NotAfter': datetime(2015, 1, 1),
            'Status': 'valid'|'expired',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

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

  • IpamExternalResourceVerificationTokens (list) –

    Verification tokens.

    • (dict) –

      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).

      • IpamExternalResourceVerificationTokenId (string) –

        The ID of the token.

      • IpamExternalResourceVerificationTokenArn (string) –

        Token ARN.

      • IpamId (string) –

        The ID of the IPAM that created the token.

      • IpamArn (string) –

        ARN of the IPAM that created the token.

      • IpamRegion (string) –

        Region of the IPAM that created the token.

      • TokenValue (string) –

        Token value.

      • TokenName (string) –

        Token name.

      • NotAfter (datetime) –

        Token expiration.

      • Status (string) –

        Token status.

      • Tags (list) –

        Token tags.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • State (string) –

        Token state.