EC2 / Client / describe_ipam_internet_registry_associations

describe_ipam_internet_registry_associations

EC2.Client.describe_ipam_internet_registry_associations(**kwargs)

Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DryRun (boolean) – Checks whether you have the required permissions for the operation, 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.

• IpamInternetRegistryAssociationIds (list) –

  The IDs of the internet registry associations to describe.

  • (string) –

• MaxResults (integer) – The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.

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

• Filters (list) –

  One or more filters to apply to the results.

  • (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.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • 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) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'IpamInternetRegistryAssociations': [
        {
            'OwnerId': 'string',
            'IpamInternetRegistryAssociationId': 'string',
            'IpamInternetRegistryAssociationArn': 'string',
            'IpamId': 'string',
            'IpamRegion': 'string',
            'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
            'OrganizationHandle': 'string',
            'Description': 'string',
            'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
            'ChildRequestXml': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The token to use to retrieve the next page of results.

  • IpamInternetRegistryAssociations (list) –

    The internet registry associations.

    • (dict) –

      Contains information about an association between an IPAM and a Regional Internet Registry (RIR) for delegated RPKI management.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the internet registry association.

      • IpamInternetRegistryAssociationId (string) –

        The ID of the internet registry association.

      • IpamInternetRegistryAssociationArn (string) –

        The Amazon Resource Name (ARN) of the internet registry association.

      • IpamId (string) –

        The ID of the associated IPAM.

      • IpamRegion (string) –

        The Amazon Web Services Region of the IPAM.

      • Rir (string) –

        The Regional Internet Registry. Possible values:

        • ripe - RIPE NCC (Europe, the Middle East, and Central Asia).

        • apnic - APNIC (Asia Pacific).

        • arin - ARIN (North America).

        • lacnic - LACNIC (Latin America and the Caribbean).

      • OrganizationHandle (string) –

        The organization handle at the internet registry.

      • Description (string) –

        The description of the internet registry association.

      • State (string) –

        The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.

      • ChildRequestXml (string) –

        The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.

      • Tags (list) –

        The tags assigned to the internet registry association.

        • (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.