Skip to content

create_service_instance

create_service_instance(
    name: ResourceName,
    service_name: ResourceName,
    spec: SpecContents,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    template_major_version: Optional[TemplateVersionPart] = None,
    template_minor_version: Optional[TemplateVersionPart] = None,
    tags: Optional[TagList] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateServiceInstanceOutput

Create a service instance.

Parameters:

  • name (ResourceName) –

    The name of the service instance to create.

  • service_name (ResourceName) –

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

  • spec (SpecContents) –

    The spec for the service instance you want to create.

  • template_major_version (Optional[TemplateVersionPart], default: None ) –

    To create a new major and minor version of the service template, exclude major Version.

  • template_minor_version (Optional[TemplateVersionPart], default: None ) –

    To create a new minor version of the service template, include a major Version.

  • tags (Optional[TagList], default: None ) –

    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.

  • client_token (Optional[ClientToken], default: None ) –

    The client token of the service instance to create.

Raises:

Source code in docs_src/capo_proton/_services/proton.py
def create_service_instance(
    self,
    name: "capo_proton.types.resource_name.ResourceName",
    service_name: "capo_proton.types.resource_name.ResourceName",
    spec: "capo_proton.types.spec_contents.SpecContents",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    template_major_version: Optional[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ] = None,
    template_minor_version: Optional[
        "capo_proton.types.template_version_part.TemplateVersionPart"
    ] = None,
    tags: Optional["capo_proton.types.tag_list.TagList"] = None,
    client_token: Optional["capo_proton.types.client_token.ClientToken"] = None,
) -> "capo_proton.types.create_service_instance_output.CreateServiceInstanceOutput":
    """<p>Create a service instance.</p>

    Args:
        name: <p>The name of the service instance to create.</p>
        service_name: <p>The name of the service the service instance is added to.</p>
        spec: <p>The spec for the service instance you want to create.</p>
        template_major_version: <p>To create a new major and minor version of the service template, <i>exclude</i> <code>major Version</code>.</p>
        template_minor_version: <p>To create a new minor version of the service template, include a <code>major Version</code>.</p>
        tags: <p>An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</p>
        client_token: <p>The client token of the service instance to create.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.conflict_exception.ConflictException: <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.create_service_instance_input.CreateServiceInstanceInput]",
    ) -> OperationResponse[
        "capo_proton.types.create_service_instance_output.CreateServiceInstanceOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.create_service_instance

        output, http_response = (
            capo_proton._operations.aws_proton20200720.create_service_instance.create_service_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_proton.types.create_service_instance_input.CreateServiceInstanceInput",
    ) -> dict[str, Any]:
        import capo_proton.types.create_service_instance_input

        return capo_proton.types.create_service_instance_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_proton.types.create_service_instance_output.CreateServiceInstanceOutput",
    ) -> dict[str, Any]:
        import capo_proton.types.create_service_instance_output

        return capo_proton.types.create_service_instance_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateServiceInstance",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_proton.types.create_service_instance_input.CreateServiceInstanceInput = {
        "name": name,
        "service_name": service_name,
        "spec": spec,
    }
    if template_major_version is not None:
        input_["template_major_version"] = template_major_version
    if template_minor_version is not None:
        input_["template_minor_version"] = template_minor_version
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output