Skip to content

describe_instance_access_control_attribute_configuration

describe_instance_access_control_attribute_configuration(
    instance_arn: InstanceArn,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> DescribeInstanceAccessControlAttributeConfigurationResponse

Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

Parameters:

  • instance_arn (InstanceArn) –

    The ARN of the IAM Identity Center instance under which the operation will be executed.

Raises:

Source code in docs_src/capo_sso_admin/_services/sso_admin.py
def describe_instance_access_control_attribute_configuration(
    self,
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.describe_instance_access_control_attribute_configuration_response.DescribeInstanceAccessControlAttributeConfigurationResponse":
    """<p>Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see <a href="/singlesignon/latest/userguide/abac.html">Attribute-Based Access Control</a> in the <i>IAM Identity Center User Guide</i>.</p>

    Args:
        instance_arn: <p>The ARN of the IAM Identity Center instance under which the operation will be executed.</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.describe_instance_access_control_attribute_configuration_request.DescribeInstanceAccessControlAttributeConfigurationRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.describe_instance_access_control_attribute_configuration_response.DescribeInstanceAccessControlAttributeConfigurationResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.describe_instance_access_control_attribute_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeInstanceAccessControlAttributeConfiguration"),
    )
    input_: capo_sso_admin.types.describe_instance_access_control_attribute_configuration_request.DescribeInstanceAccessControlAttributeConfigurationRequest = {
        "instance_arn": instance_arn
    }

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