Launch Wizard
This page documents function available when using the Launch_Wizard module, created with @service Launch_Wizard.
Index
Main.Launch_Wizard.create_deploymentMain.Launch_Wizard.delete_deploymentMain.Launch_Wizard.get_deploymentMain.Launch_Wizard.get_workloadMain.Launch_Wizard.get_workload_deployment_patternMain.Launch_Wizard.list_deployment_eventsMain.Launch_Wizard.list_deploymentsMain.Launch_Wizard.list_tags_for_resourceMain.Launch_Wizard.list_workload_deployment_patternsMain.Launch_Wizard.list_workloadsMain.Launch_Wizard.tag_resourceMain.Launch_Wizard.untag_resource
Documentation
Main.Launch_Wizard.create_deployment — Methodcreate_deployment(deployment_pattern_name, name, specifications, workload_name)
create_deployment(deployment_pattern_name, name, specifications, workload_name, params::Dict{String,<:Any})Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.
Arguments
deployment_pattern_name: The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.name: The name of the deployment.specifications: The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.workload_name: The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"dryRun": Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."tags": The tags to add to the deployment.
Main.Launch_Wizard.delete_deployment — Methoddelete_deployment(deployment_id)
delete_deployment(deployment_id, params::Dict{String,<:Any})Deletes a deployment.
Arguments
deployment_id: The ID of the deployment.
Main.Launch_Wizard.get_deployment — Methodget_deployment(deployment_id)
get_deployment(deployment_id, params::Dict{String,<:Any})Returns information about the deployment.
Arguments
deployment_id: The ID of the deployment.
Main.Launch_Wizard.get_workload — Methodget_workload(workload_name)
get_workload(workload_name, params::Dict{String,<:Any})Returns information about a workload.
Arguments
workload_name: The name of the workload.
Main.Launch_Wizard.get_workload_deployment_pattern — Methodget_workload_deployment_pattern(deployment_pattern_name, workload_name)
get_workload_deployment_pattern(deployment_pattern_name, workload_name, params::Dict{String,<:Any})Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.
Arguments
deployment_pattern_name: The name of the deployment pattern.workload_name: The name of the workload.
Main.Launch_Wizard.list_deployment_events — Methodlist_deployment_events(deployment_id)
list_deployment_events(deployment_id, params::Dict{String,<:Any})Lists the events of a deployment.
Arguments
deployment_id: The ID of the deployment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output."nextToken": The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Main.Launch_Wizard.list_deployments — Methodlist_deployments()
list_deployments(params::Dict{String,<:Any})Lists the deployments that have been created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"filters": Filters to scope the results. The following filters are supported: WORKLOADNAME - The name used in deployments. DEPLOYMENTSTATUS - COMPLETED | CREATING | DELETEINPROGRESS | DELETEINITIATING | DELETEFAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING"maxResults": The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output."nextToken": The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Main.Launch_Wizard.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags associated with a specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Launch_Wizard.list_workload_deployment_patterns — Methodlist_workload_deployment_patterns(workload_name)
list_workload_deployment_patterns(workload_name, params::Dict{String,<:Any})Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.
Arguments
workload_name: The name of the workload.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output."nextToken": The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Main.Launch_Wizard.list_workloads — Methodlist_workloads()
list_workloads(params::Dict{String,<:Any})Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output."nextToken": The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Main.Launch_Wizard.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds the specified tags to the given resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tags: One or more tags to attach to the resource.
Main.Launch_Wizard.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes the specified tags from the given resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tag_keys: Keys identifying the tags to remove.