SecurityHub / Client / list_configuration_policies
list_configuration_policies#
- SecurityHub.Client.list_configuration_policies(**kwargs)#
Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
See also: AWS API Documentation
Request Syntax
response = client.list_configuration_policies( NextToken='string', MaxResults=123 )
- Parameters:
NextToken (string) – The NextToken value that’s returned from a previous paginated
ListConfigurationPolicies
request whereMaxResults
was used but the results exceeded the value of that parameter. Pagination continues from theMaxResults
was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned theNextToken
value. This value isnull
when there are no more results to return.MaxResults (integer) – The maximum number of results that’s returned by
ListConfigurationPolicies
in each page of the response. When this parameter is used,ListConfigurationPolicies
returns the specified number of results in a single page and aNextToken
response element. You can see the remaining results of the initial request by sending anotherListConfigurationPolicies
request with the returnedNextToken
value. A valid range forMaxResults
is between 1 and 100.
- Return type:
dict
- Returns:
Response Syntax
{ 'ConfigurationPolicySummaries': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Description': 'string', 'UpdatedAt': datetime(2015, 1, 1), 'ServiceEnabled': True|False }, ], 'NextToken': 'string' }
Response Structure
(dict) –
ConfigurationPolicySummaries (list) –
Provides metadata for each of your configuration policies.
(dict) –
An object that contains the details of an Security Hub configuration policy that’s returned in a
ListConfigurationPolicies
request.Arn (string) –
The Amazon Resource Name (ARN) of the configuration policy.
Id (string) –
The universally unique identifier (UUID) of the configuration policy.
Name (string) –
The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted:
-, ., !, *, /
.Description (string) –
The description of the configuration policy.
UpdatedAt (datetime) –
The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
ServiceEnabled (boolean) –
Indicates whether the service that the configuration policy applies to is enabled in the policy.
NextToken (string) –
The
NextToken
value to include in the nextListConfigurationPolicies
request. When the results of aListConfigurationPolicies
request exceedMaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Exceptions
SecurityHub.Client.exceptions.InternalException
SecurityHub.Client.exceptions.InvalidAccessException
SecurityHub.Client.exceptions.InvalidInputException
SecurityHub.Client.exceptions.LimitExceededException
SecurityHub.Client.exceptions.AccessDeniedException
SecurityHub.Client.exceptions.AccessDeniedException