Describe Authentication Profile

connect_describe_authentication_profile

R Documentation

This API is in preview release for Connect Customer and is subject to change¶

Description¶

This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.

Describes the target authentication profile.

Usage¶

connect_describe_authentication_profile(AuthenticationProfileId,
  InstanceId)

Arguments¶

AuthenticationProfileId

[required] A unique identifier for the authentication profile.

InstanceId

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

Value¶

A list with the following syntax:

list(
  AuthenticationProfile = list(
    Id = "string",
    Arn = "string",
    Name = "string",
    Description = "string",
    AllowedIps = list(
      "string"
    ),
    BlockedIps = list(
      "string"
    ),
    IsDefault = TRUE|FALSE,
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string",
    PeriodicSessionDuration = 123,
    MaxSessionDuration = 123,
    SessionInactivityDuration = 123,
    SessionInactivityHandlingEnabled = TRUE|FALSE
  )
)

Request syntax¶

svc$describe_authentication_profile(
  AuthenticationProfileId = "string",
  InstanceId = "string"
)