Lists the configuration policies that the Security Hub CSPM delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The NextToken value that's returned from a previous paginated ListConfigurationPolicies request where MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the NextToken value. This value is null when there are no more results to return.
-
max_results
(Optional[MaxResults], default:
None
)
–
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 a NextToken response element. You can see the remaining results of the initial request by sending another ListConfigurationPolicies request with the returned NextToken value. A valid range for MaxResults is between 1 and 100.
Raises:
-
AccessDeniedException
–
You don't have permission to perform the action specified in the request.
-
InternalException
–
-
InvalidAccessException
–
The account doesn't have permission to perform this action.
-
InvalidInputException
–
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
LimitExceededException
–
The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
To view a list of configuration policies
This operation provides a list of your configuration policies, including metadata for each policy.
>>> client.list_configuration_policies(next_token='U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf', max_results=1)
Source code in docs_src/capo_securityhub/_services/security_hub.py
| def list_configuration_policies(
self,
*,
config_overrides: Optional[SecurityHubClientConfig] = None,
next_token: Optional["capo_securityhub.types.next_token.NextToken"] = None,
max_results: Optional["capo_securityhub.types.max_results.MaxResults"] = None,
) -> "capo_securityhub.types.list_configuration_policies_response.ListConfigurationPoliciesResponse":
"""<p> Lists the configuration policies that the Security Hub CSPM delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region. </p>
Args:
next_token: <p> The NextToken value that's returned from a previous paginated <code>ListConfigurationPolicies</code> request where <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination continues from the <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return. </p>
max_results: <p> The maximum number of results that's returned by <code>ListConfigurationPolicies</code> in each page of the response. When this parameter is used, <code>ListConfigurationPolicies</code> returns the specified number of results in a single page and a <code>NextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListConfigurationPolicies</code> request with the returned <code>NextToken</code> value. A valid range for <code>MaxResults</code> is between 1 and 100. </p>
Raises:
capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To view a list of configuration policies
This operation provides a list of your configuration policies, including metadata for each policy.
>>> client.list_configuration_policies(next_token='U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf', max_results=1)
"""
def _handler(
req: "OperationRequest[capo_securityhub.types.list_configuration_policies_request.ListConfigurationPoliciesRequest]",
) -> OperationResponse[
"capo_securityhub.types.list_configuration_policies_response.ListConfigurationPoliciesResponse"
]:
import capo_securityhub._operations.security_hub_api_service.list_configuration_policies
output, http_response = (
capo_securityhub._operations.security_hub_api_service.list_configuration_policies.list_configuration_policies(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListConfigurationPolicies")
)
input_: capo_securityhub.types.list_configuration_policies_request.ListConfigurationPoliciesRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|