EC2 / Client / get_ipam_discovered_accounts

get_ipam_discovered_accounts#

EC2.Client.get_ipam_discovered_accounts(**kwargs)#

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

See also: AWS API Documentation

Request Syntax

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

  • IpamResourceDiscoveryId (string) –

    [REQUIRED]

    A resource discovery ID.

  • DiscoveryRegion (string) –

    [REQUIRED]

    The Amazon Web Services Region that the account information is returned from.

  • Filters (list) –

    Discovered account filters.

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

  • NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

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

Return type:

dict

Returns:

Response Syntax

{
    'IpamDiscoveredAccounts': [
        {
            'AccountId': 'string',
            'DiscoveryRegion': 'string',
            'FailureReason': {
                'Code': 'assume-role-failure'|'throttling-failure'|'unauthorized-failure',
                'Message': 'string'
            },
            'LastAttemptedDiscoveryTime': datetime(2015, 1, 1),
            'LastSuccessfulDiscoveryTime': datetime(2015, 1, 1),
            'OrganizationalUnitId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • IpamDiscoveredAccounts (list) –

      Discovered accounts.

      • (dict) –

        An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts.

        • AccountId (string) –

          The account ID.

        • DiscoveryRegion (string) –

          The Amazon Web Services Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region.

        • FailureReason (dict) –

          The resource discovery failure reason.

          • Code (string) –

            The discovery failure code.

            • assume-role-failure - IPAM could not assume the Amazon Web Services IAM service-linked role. This could be because of any of the following:

              • SLR has not been created yet and IPAM is still creating it.

              • You have opted-out of the IPAM home Region.

              • Account you are using as your IPAM account has been suspended.

            • throttling-failure - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the Amazon Web Services IAM SLR.

            • unauthorized-failure - Amazon Web Services account making the request is not authorized. For more information, see AuthFailure in the Amazon Elastic Compute Cloud API Reference.

          • Message (string) –

            The discovery failure message.

        • LastAttemptedDiscoveryTime (datetime) –

          The last attempted resource discovery time.

        • LastSuccessfulDiscoveryTime (datetime) –

          The last successful resource discovery time.

        • OrganizationalUnitId (string) –

          The ID of an Organizational Unit in Amazon Web Services Organizations.

    • NextToken (string) –

      Specify the pagination token from a previous request to retrieve the next page of results.