describe_security_profile `async` ¶

describe_security_profile(
    security_profile_id: SecurityProfileId,
    instance_id: InstanceId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> DescribeSecurityProfileResponse

Gets basic information about the security profile.

For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Parameters:

security_profile_id (SecurityProfileId) –

The identifier for the security profle.
instance_id (InstanceId) –

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Raises:

InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidParameterException –

One or more of the specified parameters are not valid.
InvalidRequestException –

The request is not valid.
ResourceNotFoundException –

The specified resource was not found.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

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

Source code in docs_src/capo_connect/_services/async_connect.py

async def describe_security_profile(
    self,
    security_profile_id: "capo_connect.types.security_profile_id.SecurityProfileId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.describe_security_profile_response.DescribeSecurityProfileResponse":
    """<p>Gets basic information about the security profile.</p> <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Connect Customer Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </p>

    Args:
        security_profile_id: <p>The identifier for the security profle.</p>
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.describe_security_profile_request.DescribeSecurityProfileRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.describe_security_profile_response.DescribeSecurityProfileResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_security_profile

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.describe_security_profile.async_describe_security_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSecurityProfile")
    )
    input_: capo_connect.types.describe_security_profile_request.DescribeSecurityProfileRequest = {
        "security_profile_id": security_profile_id,
        "instance_id": instance_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_security_profile async ¶

describe_security_profile `async` ¶