EC2 / Client / get_ipam_policy_organization_targets

get_ipam_policy_organization_targets

EC2.Client.get_ipam_policy_organization_targets(**kwargs)

Gets the Amazon Web Services Organizations targets for an IPAM policy.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.

See also: AWS API Documentation

Request Syntax

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

  • MaxResults (integer) – The maximum number of results to return in a single call.

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

  • IpamPolicyId (string) –

    [REQUIRED]

    The ID of the IPAM policy for which to get Amazon Web Services Organizations targets.

  • Filters (list) –

    One or more filters for the Amazon Web Services Organizations targets.

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

{
    'OrganizationTargets': [
        {
            'OrganizationTargetId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • OrganizationTargets (list) –

      The Amazon Web Services Organizations targets for an IPAM policy.

      • (dict) –

        The Amazon Web Services Organizations target for an IPAM policy.

        • OrganizationTargetId (string) –

          The ID of a Amazon Web Services Organizations target for an IPAM policy.

    • NextToken (string) –

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