create_index async ¶

async def create_index(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    ordered_indexed_attribute_list: "capo_clouddirectory.types.attribute_key_list.AttributeKeyList",
    is_unique: "capo_clouddirectory.types.bool.Bool",
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    parent_reference: Optional[
        "capo_clouddirectory.types.object_reference.ObjectReference"
    ] = None,
    link_name: Optional["capo_clouddirectory.types.link_name.LinkName"] = None,
) -> "capo_clouddirectory.types.create_index_response.CreateIndexResponse":
    """<p>Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html">Indexing and search</a> for more information.</p>

    Args:
        directory_arn: <p>The ARN of the directory where the index should be created.</p>
        ordered_indexed_attribute_list: <p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>
        is_unique: <p>Indicates whether the attribute that is being indexed has unique values or not.</p>
        parent_reference: <p>A reference to the parent object that contains the index object.</p>
        link_name: <p>The name of the link between the parent object and the index object.</p>

    Raises:
        capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
        capo_clouddirectory.errors.directory_not_enabled_exception.DirectoryNotEnabledException: <p>Operations are only permitted on enabled directories.</p>
        capo_clouddirectory.errors.facet_validation_exception.FacetValidationException: <p>The <a>Facet</a> that you provided was not well formed or could not be validated with the schema.</p>
        capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
        capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
        capo_clouddirectory.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that limits are exceeded. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Limits</a> for more information.</p>
        capo_clouddirectory.errors.link_name_already_in_use_exception.LinkNameAlreadyInUseException: <p>Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.</p>
        capo_clouddirectory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_clouddirectory.errors.unsupported_index_type_exception.UnsupportedIndexTypeException: <p>Indicates that the requested index type is not supported.</p>
        capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
        capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create an index

        >>> await client.create_index(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8', ordered_indexed_attribute_list=[], is_unique=True, parent_reference={}, link_name='Examplelink')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.create_index_request.CreateIndexRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.create_index_response.CreateIndexResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.create_index

        (
            output,
            http_response,
        ) = await capo_clouddirectory._operations.amazon_cloud_directory_20170111.create_index.async_create_index(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateIndex")
    )
    input_: capo_clouddirectory.types.create_index_request.CreateIndexRequest = {
        "directory_arn": directory_arn,
        "ordered_indexed_attribute_list": ordered_indexed_attribute_list,
        "is_unique": is_unique,
    }
    if parent_reference is not None:
        input_["parent_reference"] = parent_reference
    if link_name is not None:
        input_["link_name"] = link_name

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output