FMS / Client / list_discovered_resources

list_discovered_resources#

FMS.Client.list_discovered_resources(**kwargs)#

Returns an array of resources in the organization’s accounts that are available to be associated with a resource set.

See also: AWS API Documentation

Request Syntax

response = client.list_discovered_resources(
    MemberAccountIds=[
        'string',
    ],
    ResourceType='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MemberAccountIds (list) –

    [REQUIRED]

    The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

    • (string) –

  • ResourceType (string) –

    [REQUIRED]

    The type of resources to discover.

  • MaxResults (integer) – The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

  • NextToken (string) – When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'URI': 'string',
            'AccountId': 'string',
            'Type': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      Details of the resources that were discovered.

      • (dict) –

        A resource in the organization that’s available to be associated with a Firewall Manager resource set.

        • URI (string) –

          The universal resource identifier (URI) of the discovered resource.

        • AccountId (string) –

          The Amazon Web Services account ID associated with the discovered resource.

        • Type (string) –

          The type of the discovered resource.

        • Name (string) –

          The name of the discovered resource.

    • NextToken (string) –

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Exceptions

  • FMS.Client.exceptions.InvalidOperationException

  • FMS.Client.exceptions.InvalidInputException

  • FMS.Client.exceptions.InternalErrorException