Amazon Bedrock

Sets the account-level enforced guardrail configuration.

See also: AWS API Documentation

Request Syntax

client.put_enforced_guardrail_configuration(
    configId='string',
    guardrailInferenceConfig={
        'guardrailIdentifier': 'string',
        'guardrailVersion': 'string',
        'inputTags': 'HONOR'|'IGNORE'
    }
)

type configId:

string

param configId:

Unique ID for the account enforced configuration.

type guardrailInferenceConfig:

dict

param guardrailInferenceConfig:

[REQUIRED]

Account-level enforced guardrail input configuration.

• guardrailIdentifier (string) -- [REQUIRED]

  Identifier for the guardrail, could be the ID or the ARN.

• guardrailVersion (string) -- [REQUIRED]

  Numerical guardrail version.

• inputTags (string) -- [REQUIRED]

  Whether to honor or ignore input tags at runtime.

rtype:

dict

returns:

Response Syntax

{
    'configId': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

• (dict) --

  • configId (string) --

    Unique ID for the account enforced configuration.

  • updatedAt (datetime) --

    Timestamp.

  • updatedBy (string) --

    The ARN of the role used to update the configuration.

Deletes the account-level enforced guardrail configuration.

See also: AWS API Documentation

Request Syntax

client.delete_enforced_guardrail_configuration(
    configId='string'
)

type configId:

string

param configId:

[REQUIRED]

Unique ID for the account enforced configuration.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists the account-level enforced guardrail configurations.

See also: AWS API Documentation

Request Syntax

client.list_enforced_guardrails_configuration(
    nextToken='string'
)

type nextToken:

string

param nextToken:

Opaque continuation token of previous paginated response.

rtype:

dict

returns:

Response Syntax

{
    'guardrailsConfig': [
        {
            'configId': 'string',
            'guardrailArn': 'string',
            'guardrailId': 'string',
            'inputTags': 'HONOR'|'IGNORE',
            'guardrailVersion': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'owner': 'ACCOUNT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • guardrailsConfig (list) --

    Array of AccountEnforcedGuardrailOutputConfiguration objects.

    • (dict) --

      Account enforced guardrail output configuration.

      • configId (string) --

        Unique ID for the account enforced configuration.

      • guardrailArn (string) --

        ARN representation for the guardrail.

      • guardrailId (string) --

        Unique ID for the guardrail.

      • inputTags (string) --

        Whether to honor or ignore input tags at runtime.

      • guardrailVersion (string) --

        Numerical guardrail version.

      • createdAt (datetime) --

        Timestamp.

      • createdBy (string) --

        The ARN of the role used to update the configuration.

      • updatedAt (datetime) --

        Timestamp.

      • updatedBy (string) --

        The ARN of the role used to update the configuration.

      • owner (string) --

        Configuration owner type.

  • nextToken (string) --

    Opaque continuation token of previous paginated response.