VerifiedPermissions / Client / get_schema

get_schema#

VerifiedPermissions.Client.get_schema(**kwargs)#

Retrieve the details for the specified schema in the specified policy store.

See also: AWS API Documentation

Request Syntax

response = client.get_schema(
    policyStoreId='string'
)
Parameters:

policyStoreId (string) –

[REQUIRED]

Specifies the ID of the policy store that contains the schema.

Return type:

dict

Returns:

Response Syntax

{
    'policyStoreId': 'string',
    'schema': 'string',
    'createdDate': datetime(2015, 1, 1),
    'lastUpdatedDate': datetime(2015, 1, 1),
    'namespaces': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • policyStoreId (string) –

      The ID of the policy store that contains the schema.

    • schema (string) –

      The body of the schema, written in Cedar schema JSON.

    • createdDate (datetime) –

      The date and time that the schema was originally created.

    • lastUpdatedDate (datetime) –

      The date and time that the schema was most recently updated.

    • namespaces (list) –

      The namespaces of the entities referenced by this schema.

      • (string) –

Exceptions

  • VerifiedPermissions.Client.exceptions.ValidationException

  • VerifiedPermissions.Client.exceptions.AccessDeniedException

  • VerifiedPermissions.Client.exceptions.ResourceNotFoundException

  • VerifiedPermissions.Client.exceptions.ThrottlingException

  • VerifiedPermissions.Client.exceptions.InternalServerException