list_permission_sets ¶

list_permission_sets(
    instance_arn: InstanceArn,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxResults] = None,
) -> ListPermissionSetsResponse

Lists the PermissionSets in an IAM Identity Center instance.

Parameters:

instance_arn (InstanceArn) –

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
next_token (Optional[Token], default: None ) –

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to display for the assignment.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

The request processing has failed because of an unknown error, exception, or failure with an internal server.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sso_admin/_services/sso_admin.py

def list_permission_sets(
    self,
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    next_token: Optional["capo_sso_admin.types.token.Token"] = None,
    max_results: Optional["capo_sso_admin.types.max_results.MaxResults"] = None,
) -> (
    "capo_sso_admin.types.list_permission_sets_response.ListPermissionSetsResponse"
):
    """<p>Lists the <a>PermissionSet</a>s in an IAM Identity Center instance.</p>

    Args:
        instance_arn: <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
        next_token: <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
        max_results: <p>The maximum number of results to display for the assignment.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.list_permission_sets_request.ListPermissionSetsRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.list_permission_sets_response.ListPermissionSetsResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.list_permission_sets

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.list_permission_sets.list_permission_sets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPermissionSets")
    )
    input_: capo_sso_admin.types.list_permission_sets_request.ListPermissionSetsRequest = {
        "instance_arn": instance_arn
    }
    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