create_directory `async` ¶

create_directory(
    name: DirectoryName,
    schema_arn: Arn,
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
) -> CreateDirectoryResponse

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

Parameters:

name (DirectoryName) –

The name of the Directory. Should be unique per account, per region.
schema_arn (Arn) –

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Raises:

AccessDeniedException –

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
DirectoryAlreadyExistsException –

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
InternalServiceException –

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 AWS Service Health Dashboard site to see if there are any operational issues with the service.
InvalidArnException –

Indicates that the provided ARN value is not valid.
LimitExceededException –

Indicates that limits are exceeded. See Limits for more information.
ResourceNotFoundException –

The specified resource could not be found.
RetryableConflictException –

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.
ValidationException –

Indicates that your request is malformed in some manner. See the exception message.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To create a new Cloud Directory

>>> await client.create_directory(name='ExampleCD', schema_arn='arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1')

Source code in docs_src/capo_clouddirectory/_services/async_cloud_directory.py

async def create_directory(
    self,
    name: "capo_clouddirectory.types.directory_name.DirectoryName",
    schema_arn: "capo_clouddirectory.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
) -> "capo_clouddirectory.types.create_directory_response.CreateDirectoryResponse":
    """<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p> <p>You can also quickly create a directory using a managed schema, called the <code>QuickStartSchema</code>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html">Managed Schema</a> in the <i>Amazon Cloud Directory Developer Guide</i>.</p>

    Args:
        name: <p>The name of the <a>Directory</a>. Should be unique per account, per region.</p>
        schema_arn: <p>The Amazon Resource Name (ARN) of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</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_already_exists_exception.DirectoryAlreadyExistsException: <p>Indicates that a <a>Directory</a> could not be created due to a naming conflict. Choose a different name and try again.</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.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.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 a new Cloud Directory

        >>> await client.create_directory(name='ExampleCD', schema_arn='arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.create_directory_request.CreateDirectoryRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.create_directory_response.CreateDirectoryResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.create_directory

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDirectory")
    )
    input_: capo_clouddirectory.types.create_directory_request.CreateDirectoryRequest = {
        "name": name,
        "schema_arn": schema_arn,
    }

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

create_directory async ¶

create_directory `async` ¶