EC2 / Client / describe_ipam_scopes

describe_ipam_scopes

EC2.Client.describe_ipam_scopes(**kwargs)

Get information about your IPAM scopes.

See also: AWS API Documentation

Request Syntax

response = client.describe_ipam_scopes(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    IpamScopeIds=[
        '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.

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

• MaxResults (integer) – The maximum number of results to return in the request.

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

• IpamScopeIds (list) –

  The IDs of the scopes you want information on.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'IpamScopes': [
        {
            'OwnerId': 'string',
            'IpamScopeId': 'string',
            'IpamScopeArn': 'string',
            'IpamArn': 'string',
            'IpamRegion': 'string',
            'IpamScopeType': 'public'|'private',
            'IsDefault': True|False,
            'Description': 'string',
            'PoolCount': 123,
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

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.

  • IpamScopes (list) –

    The scopes you want information on.

    • (dict) –

      In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

      For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

      • OwnerId (string) –

        The Amazon Web Services account ID of the owner of the scope.

      • IpamScopeId (string) –

        The ID of the scope.

      • IpamScopeArn (string) –

        The Amazon Resource Name (ARN) of the scope.

      • IpamArn (string) –

        The ARN of the IPAM.

      • IpamRegion (string) –

        The Amazon Web Services Region of the IPAM scope.

      • IpamScopeType (string) –

        The type of the scope.

      • IsDefault (boolean) –

        Defines if the scope is the default scope or not.

      • Description (string) –

        The description of the scope.

      • PoolCount (integer) –

        The number of pools in the scope.

      • State (string) –

        The state of the IPAM scope.

      • Tags (list) –

        The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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