Skip to content

list_account_assignments

list_account_assignments(
    instance_arn: InstanceArn,
    account_id: TargetId,
    permission_set_arn: PermissionSetArn,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[Token] = None,
) -> ListAccountAssignmentsResponse

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

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.

  • account_id (TargetId) –

    The identifier of the Amazon Web Services account from which to list the assignments.

  • permission_set_arn (PermissionSetArn) –

    The ARN of the permission set from which to list assignments.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to display for the assignment.

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

Raises:

Source code in docs_src/capo_sso_admin/_services/sso_admin.py
def list_account_assignments(
    self,
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn",
    account_id: "capo_sso_admin.types.target_id.TargetId",
    permission_set_arn: "capo_sso_admin.types.permission_set_arn.PermissionSetArn",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    max_results: Optional["capo_sso_admin.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_sso_admin.types.token.Token"] = None,
) -> "capo_sso_admin.types.list_account_assignments_response.ListAccountAssignmentsResponse":
    """<p>Lists the assignee of the specified Amazon Web Services account with the specified permission set.</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>
        account_id: <p>The identifier of the Amazon Web Services account from which to list the assignments.</p>
        permission_set_arn: <p>The ARN of the permission set from which to list assignments.</p>
        max_results: <p>The maximum number of results to display for the assignment.</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>

    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_account_assignments_request.ListAccountAssignmentsRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.list_account_assignments_response.ListAccountAssignmentsResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.list_account_assignments

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccountAssignments")
    )
    input_: capo_sso_admin.types.list_account_assignments_request.ListAccountAssignmentsRequest = {
        "instance_arn": instance_arn,
        "account_id": account_id,
        "permission_set_arn": permission_set_arn,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output