Skip to content

create_application

create_application(
    idc_instance_arn: ARN,
    workspace_name: WorkspaceName,
    name: ApplicationName,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    description: Optional[Description] = None,
    tags: Optional[TagMap] = None,
) -> CreateApplicationResponse

Creates a new application for the workspace and IdC application provided

Parameters:

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

    Unique client token for idempotent request handling

  • idc_instance_arn (ARN) –

    Identity Center Instance ARN to create the application in

  • workspace_name (WorkspaceName) –

    Name of the workspace to associate with the underlying Application

  • name (ApplicationName) –

    Name of the application

  • description (Optional[Description], default: None ) –

    Description of the application

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

    A list of key-value pairs that contain metadata for the application.

Raises:

  • AccessDeniedException –

    Access is denied.

  • ConflictingOperationException –

    Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

  • InternalFailureException –

    IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • LimitExceededException –

    You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • ResourceNotFoundException –

    The requested resource can't be found.

  • ThrottlingException –

    Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py
def create_application(
    self,
    idc_instance_arn: "capo_iotsitewise.types.arn.ARN",
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    name: "capo_iotsitewise.types.application_name.ApplicationName",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
    description: Optional["capo_iotsitewise.types.description.Description"] = None,
    tags: Optional["capo_iotsitewise.types.tag_map.TagMap"] = None,
) -> "capo_iotsitewise.types.create_application_response.CreateApplicationResponse":
    """<p>Creates a new application for the workspace and IdC application provided</p>

    Args:
        client_token: <p>Unique client token for idempotent request handling</p>
        idc_instance_arn: <p>Identity Center Instance ARN to create the application in</p>
        workspace_name: <p>Name of the workspace to associate with the underlying Application</p>
        name: <p>Name of the application</p>
        description: <p>Description of the application</p>
        tags: <p>A list of key-value pairs that contain metadata for the application.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.create_application_request.CreateApplicationRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.create_application_response.CreateApplicationResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_application

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.create_application.create_application(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateApplication")
    )
    input_: capo_iotsitewise.types.create_application_request.CreateApplicationRequest = {
        "idc_instance_arn": idc_instance_arn,
        "workspace_name": workspace_name,
        "name": name,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

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