SupplyChain / Client / create_instance

create_instance#

SupplyChain.Client.create_instance(**kwargs)#

Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.

This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

See also: AWS API Documentation

Request Syntax

response = client.create_instance(
    instanceName='string',
    instanceDescription='string',
    kmsKeyArn='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • instanceName (string) – The AWS Supply Chain instance name.

  • instanceDescription (string) – The AWS Supply Chain instance description.

  • kmsKeyArn (string) – The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don’t provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.

  • tags (dict) –

    The Amazon Web Services tags of an instance to be created.

    • (string) –

      • (string) –

  • clientToken (string) –

    The client token for idempotency.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'instance': {
        'instanceId': 'string',
        'awsAccountId': 'string',
        'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
        'errorMessage': 'string',
        'webAppDnsDomain': 'string',
        'createdTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'instanceName': 'string',
        'instanceDescription': 'string',
        'kmsKeyArn': 'string',
        'versionNumber': 123.0
    }
}

Response Structure

  • (dict) –

    The response parameters for CreateInstance.

    • instance (dict) –

      The AWS Supply Chain instance resource data details.

      • instanceId (string) –

        The Amazon Web Services Supply Chain instance identifier.

      • awsAccountId (string) –

        The Amazon Web Services account ID that owns the instance.

      • state (string) –

        The state of the instance.

      • errorMessage (string) –

        The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

      • webAppDnsDomain (string) –

        The WebApp DNS domain name of the instance.

      • createdTime (datetime) –

        The instance creation timestamp.

      • lastModifiedTime (datetime) –

        The instance last modified timestamp.

      • instanceName (string) –

        The Amazon Web Services Supply Chain instance name.

      • instanceDescription (string) –

        The Amazon Web Services Supply Chain instance description.

      • kmsKeyArn (string) –

        The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      • versionNumber (float) –

        The version number of the instance.

Exceptions