Proton / Client / update_component

update_component

Proton.Client.update_component(**kwargs)

Update a component.

There are a few modes for updating a component. The deploymentType field defines the mode.

Note

You can’t update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton User Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_component(
    clientToken='string',
    deploymentType='NONE'|'CURRENT_VERSION',
    description='string',
    name='string',
    serviceInstanceName='string',
    serviceName='string',
    serviceSpec='string',
    templateFile='string'
)

Parameters:

• clientToken (string) –

  The client token for the updated component.

  This field is autopopulated if not provided.

• deploymentType (string) –

  [REQUIRED]

  The deployment type. It defines the mode for updating a component, as follows:

  NONE

  In this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

  CURRENT_VERSION

  In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

• description (string) – An optional customer-provided description of the component.

• name (string) –

  [REQUIRED]

  The name of the component to update.

• serviceInstanceName (string) – The name of the service instance that you want to attach this component to. Don’t specify to keep the component’s current service instance attachment. Specify an empty string to detach the component from the service instance it’s attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

• serviceName (string) – The name of the service that serviceInstanceName is associated with. Don’t specify to keep the component’s current service instance attachment. Specify an empty string to detach the component from the service instance it’s attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

• serviceSpec (string) – The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

• templateFile (string) –

  A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

  Note

  Components support a single IaC file, even if you use Terraform as your template language.

Return type:

dict

Returns:

Response Syntax

{
    'component': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentName': 'string',
        'lastAttemptedDeploymentId': 'string',
        'lastClientRequestToken': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'lastModifiedAt': datetime(2015, 1, 1),
        'lastSucceededDeploymentId': 'string',
        'name': 'string',
        'serviceInstanceName': 'string',
        'serviceName': 'string',
        'serviceSpec': 'string'
    }
}

Response Structure

• (dict) –

  • component (dict) –

    The detailed data of the updated component.

    • arn (string) –

      The Amazon Resource Name (ARN) of the component.

    • createdAt (datetime) –

      The time when the component was created.

    • deploymentStatus (string) –

      The component deployment status.

    • deploymentStatusMessage (string) –

      The message associated with the component deployment status.

    • description (string) –

      A description of the component.

    • environmentName (string) –

      The name of the Proton environment that this component is associated with.

    • lastAttemptedDeploymentId (string) –

      The ID of the last attempted deployment of this component.

    • lastClientRequestToken (string) –

      The last token the client requested.

    • lastDeploymentAttemptedAt (datetime) –

      The time when a deployment of the component was last attempted.

    • lastDeploymentSucceededAt (datetime) –

      The time when the component was last deployed successfully.

    • lastModifiedAt (datetime) –

      The time when the component was last modified.

    • lastSucceededDeploymentId (string) –

      The ID of the last successful deployment of this component.

    • name (string) –

      The name of the component.

    • serviceInstanceName (string) –

      The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

    • serviceName (string) –

      The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

    • serviceSpec (string) –

      The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

Exceptions

• Proton.Client.exceptions.ServiceQuotaExceededException

• Proton.Client.exceptions.ValidationException

• Proton.Client.exceptions.AccessDeniedException

• Proton.Client.exceptions.ThrottlingException

• Proton.Client.exceptions.ConflictException

• Proton.Client.exceptions.ResourceNotFoundException

• Proton.Client.exceptions.InternalServerException