describe_permission_set

SSOAdmin.Client.describe_permission_set(**kwargs)

Gets the details of the permission set.

See also: AWS API Documentation

Request Syntax

response = client.describe_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    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 AWS Service Namespaces in the AWS General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set.

Return type

dict

Returns

Response Syntax

{
    'PermissionSet': {
        'Name': 'string',
        'PermissionSetArn': 'string',
        'Description': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'SessionDuration': 'string',
        'RelayState': 'string'
    }
}

Response Structure

  • (dict) --

    • PermissionSet (dict) --

      Describes the level of access on an AWS account.

      • Name (string) --

        The name of the permission set.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

      • Description (string) --

        The description of the PermissionSet.

      • CreatedDate (datetime) --

        The date that the permission set was created.

      • SessionDuration (string) --

        The length of time that the application user sessions are valid for in the ISO-8601 standard.

      • RelayState (string) --

        Used to redirect users within the application during the federation authentication process.

Exceptions

  • SSOAdmin.Client.exceptions.ResourceNotFoundException
  • SSOAdmin.Client.exceptions.InternalServerException
  • SSOAdmin.Client.exceptions.ThrottlingException
  • SSOAdmin.Client.exceptions.ValidationException
  • SSOAdmin.Client.exceptions.AccessDeniedException