CloudSearch / Client / update_service_access_policies

update_service_access_policies

CloudSearch.Client.update_service_access_policies(**kwargs)

Configures the access rules that control access to the domain’s document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

See also: AWS API Documentation

Request Syntax

response = client.update_service_access_policies(
    DomainName='string',
    AccessPolicies='string'
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

• AccessPolicies (string) –

  [REQUIRED]

  The access rules you want to configure. These rules replace any existing rules.

Return type:

dict

Returns:

Response Syntax

{
    'AccessPolicies': {
        'Options': 'string',
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

• (dict) –

  The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

  • AccessPolicies (dict) –

    The access rules configured for the domain.

    • Options (string) –

      Access rules for a domain’s document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

    • Status (dict) –

      The status of domain configuration option.

      • CreationDate (datetime) –

        A timestamp for when this option was created.

      • UpdateDate (datetime) –

        A timestamp for when this option was last updated.

      • UpdateVersion (integer) –

        A unique integer that indicates when this option was last updated.

      • State (string) –

        The state of processing a change to an option. Possible values:

        • RequiresIndexDocuments: the option’s latest value will not be deployed until IndexDocuments has been called and indexing is complete.

        • Processing: the option’s latest value is in the process of being activated.

        • Active: the option’s latest value is completely deployed.

        • FailedToValidate: the option value is not compatible with the domain’s data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

      • PendingDeletion (boolean) –

        Indicates that the option will be deleted once processing is complete.

Exceptions

• CloudSearch.Client.exceptions.BaseException

• CloudSearch.Client.exceptions.InternalException

• CloudSearch.Client.exceptions.LimitExceededException

• CloudSearch.Client.exceptions.ResourceNotFoundException

• CloudSearch.Client.exceptions.InvalidTypeException

• CloudSearch.Client.exceptions.ValidationException