FMS / Client / list_resource_sets

list_resource_sets#

FMS.Client.list_resource_sets(**kwargs)#

Returns an array of ResourceSetSummary objects.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_sets(
    NextToken='string',
    MaxResults=123
)
Parameters:

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

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

Return type:

dict

Returns:

Response Syntax

{
    'ResourceSets': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'LastUpdateTime': datetime(2015, 1, 1),
            'ResourceSetStatus': 'ACTIVE'|'OUT_OF_ADMIN_SCOPE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ResourceSets (list) –

      An array of ResourceSetSummary objects.

      • (dict) –

        Summarizes the resource sets used in a policy.

        • Id (string) –

          A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Name (string) –

          The descriptive name of the resource set. You can’t change the name of a resource set after you create it.

        • Description (string) –

          A description of the resource set.

        • LastUpdateTime (datetime) –

          The last time that the resource set was changed.

        • ResourceSetStatus (string) –

          Indicates whether the resource set is in or out of an admin’s Region scope.

          • ACTIVE - The administrator can manage and delete the resource set.

          • OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can’t edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won’t be protected.

    • 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