Organizations / Paginator / ListEffectivePolicyValidationErrors

ListEffectivePolicyValidationErrors

class Organizations.Paginator.ListEffectivePolicyValidationErrors
paginator = client.get_paginator('list_effective_policy_validation_errors')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Organizations.Client.list_effective_policy_validation_errors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AccountId='string',
    PolicyType='TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY'|'CHATBOT_POLICY'|'DECLARATIVE_POLICY_EC2'|'SECURITYHUB_POLICY'|'INSPECTOR_POLICY'|'UPGRADE_ROLLOUT_POLICY'|'BEDROCK_POLICY'|'S3_POLICY'|'NETWORK_SECURITY_DIRECTOR_POLICY',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.

  • PolicyType (string) –

    [REQUIRED]

    The type of policy that you want information about. You can specify one of the following values:

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AccountId': 'string',
    'PolicyType': 'TAG_POLICY'|'BACKUP_POLICY'|'AISERVICES_OPT_OUT_POLICY'|'CHATBOT_POLICY'|'DECLARATIVE_POLICY_EC2'|'SECURITYHUB_POLICY'|'INSPECTOR_POLICY'|'UPGRADE_ROLLOUT_POLICY'|'BEDROCK_POLICY'|'S3_POLICY'|'NETWORK_SECURITY_DIRECTOR_POLICY',
    'Path': 'string',
    'EvaluationTimestamp': datetime(2015, 1, 1),
    'EffectivePolicyValidationErrors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'PathToError': 'string',
            'ContributingPolicies': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • AccountId (string) –

      The ID of the specified account.

    • PolicyType (string) –

      The specified policy type. One of the following values:

    • Path (string) –

      The path in the organization where the specified account exists.

    • EvaluationTimestamp (datetime) –

      The time when the latest effective policy was generated for the specified account.

    • EffectivePolicyValidationErrors (list) –

      The EffectivePolicyValidationError object contains details about the validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.

      • (dict) –

        Contains details about the validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.

        • ErrorCode (string) –

          The error code for the validation error. For example, ELEMENTS_TOO_MANY.

        • ErrorMessage (string) –

          The error message for the validation error.

        • PathToError (string) –

          The path within the effective policy where the validation error occurred.

        • ContributingPolicies (list) –

          The individual policies inherited and attached to the account which contributed to the validation error.

          • (string) –