Proton / Client / create_service_instance

create_service_instance#

Proton.Client.create_service_instance(**kwargs)#

Create a service instance.

See also: AWS API Documentation

Request Syntax

response = client.create_service_instance(
    clientToken='string',
    name='string',
    serviceName='string',
    spec='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateMajorVersion='string',
    templateMinorVersion='string'
)
Parameters:

  • clientToken (string) –

    The client token of the service instance to create.

    This field is autopopulated if not provided.

  • name (string) –

    [REQUIRED]

    The name of the service instance to create.

  • serviceName (string) –

    [REQUIRED]

    The name of the service the service instance is added to.

  • spec (string) –

    [REQUIRED]

    The spec for the service instance you want to create.

  • tags (list) –

    An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

    • (dict) –

      A description of a resource tag.

      • key (string) – [REQUIRED]

        The key of the resource tag.

      • value (string) – [REQUIRED]

        The value of the resource tag.

  • templateMajorVersion (string) – To create a new major and minor version of the service template, exclude major Version.

  • templateMinorVersion (string) – To create a new minor version of the service template, include a major Version.

Return type:

dict

Returns:

Response Syntax

{
    'serviceInstance': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'environmentName': 'string',
        'lastAttemptedDeploymentId': 'string',
        'lastClientRequestToken': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'lastSucceededDeploymentId': 'string',
        'name': 'string',
        'serviceName': 'string',
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

  • (dict) –

    • serviceInstance (dict) –

      The detailed data of the service instance being created.

      • arn (string) –

        The Amazon Resource Name (ARN) of the service instance.

      • createdAt (datetime) –

        The time when the service instance was created.

      • deploymentStatus (string) –

        The service instance deployment status.

      • deploymentStatusMessage (string) –

        The message associated with the service instance deployment status.

      • environmentName (string) –

        The name of the environment that the service instance was deployed into.

      • lastAttemptedDeploymentId (string) –

        The ID of the last attempted deployment of this service instance.

      • lastClientRequestToken (string) –

        The last client request token received.

      • lastDeploymentAttemptedAt (datetime) –

        The time when a deployment of the service instance was last attempted.

      • lastDeploymentSucceededAt (datetime) –

        The time when the service instance was last deployed successfully.

      • lastSucceededDeploymentId (string) –

        The ID of the last successful deployment of this service instance.

      • name (string) –

        The name of the service instance.

      • serviceName (string) –

        The name of the service that the service instance belongs to.

      • spec (string) –

        The service spec that was used to create the service instance.

      • templateMajorVersion (string) –

        The major version of the service template that was used to create the service instance.

      • templateMinorVersion (string) –

        The minor version of the service template that was used to create the service instance.

      • templateName (string) –

        The name of the service template that was used to create the service instance.

Exceptions