SDK for PHP 3.x

AWS Launch Wizard 2018-05-10

Client: Aws\LaunchWizard\LaunchWizardClient
Service ID: launch-wizard
Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS Launch Wizard (2018-05-10), and shows how to use the Aws\LaunchWizard\LaunchWizardClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateDeployment ( array $params = [] )
Creates a deployment for the given workload.
DeleteDeployment ( array $params = [] )
Deletes a deployment.
GetDeployment ( array $params = [] )
Returns information about the deployment.
GetWorkload ( array $params = [] )
Returns information about a workload.
GetWorkloadDeploymentPattern ( array $params = [] )
Returns details for a given workload and deployment pattern, including the available specifications.
ListDeploymentEvents ( array $params = [] )
Lists the events of a deployment.
ListDeployments ( array $params = [] )
Lists the deployments that have been created.
ListTagsForResource ( array $params = [] )
Lists the tags associated with a specified resource.
ListWorkloadDeploymentPatterns ( array $params = [] )
Lists the workload deployment patterns for a given workload name.
ListWorkloads ( array $params = [] )
Lists the available workload names.
TagResource ( array $params = [] )
Adds the specified tags to the given resource.
UntagResource ( array $params = [] )
Removes the specified tags from the given resource.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDeploymentEvents
ListDeployments
ListWorkloadDeploymentPatterns
ListWorkloads

Operations

CreateDeployment 

$result = $client->createDeployment([/* ... */]);
$promise = $client->createDeploymentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDeployment([
    'deploymentPatternName' => '<string>', // REQUIRED
    'dryRun' => true || false,
    'name' => '<string>', // REQUIRED
    'specifications' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentPatternName
Required: Yes
Type: string

The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

dryRun
Type: boolean

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.

name
Required: Yes
Type: string

The name of the deployment.

specifications
Required: Yes
Type: Associative array of custom strings keys (KeyString) to strings

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the deployment.

workloadName
Required: Yes
Type: string

The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

Result Syntax

[
    'deploymentId' => '<string>',
]

Result Details

Members
deploymentId
Type: string

The ID of the deployment.

Errors

ResourceLimitException:

You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

DeleteDeployment 

$result = $client->deleteDeployment([/* ... */]);
$promise = $client->deleteDeploymentAsync([/* ... */]);

Deletes a deployment.

Parameter Syntax

$result = $client->deleteDeployment([
    'deploymentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentId
Required: Yes
Type: string

The ID of the deployment.

Result Syntax

[
    'status' => 'COMPLETED|CREATING|DELETE_IN_PROGRESS|DELETE_INITIATING|DELETE_FAILED|DELETED|FAILED|IN_PROGRESS|VALIDATING',
    'statusReason' => '<string>',
]

Result Details

Members
status
Type: string

The status of the deployment.

statusReason
Type: string

The reason for the deployment status.

Errors

ResourceLimitException:

You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

GetDeployment 

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Returns information about the deployment.

Parameter Syntax

$result = $client->getDeployment([
    'deploymentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentId
Required: Yes
Type: string

The ID of the deployment.

Result Syntax

[
    'deployment' => [
        'createdAt' => <DateTime>,
        'deletedAt' => <DateTime>,
        'deploymentArn' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'patternName' => '<string>',
        'resourceGroup' => '<string>',
        'specifications' => ['<string>', ...],
        'status' => 'COMPLETED|CREATING|DELETE_IN_PROGRESS|DELETE_INITIATING|DELETE_FAILED|DELETED|FAILED|IN_PROGRESS|VALIDATING',
        'tags' => ['<string>', ...],
        'workloadName' => '<string>',
    ],
]

Result Details

Members
deployment
Type: DeploymentData structure

An object that details the deployment.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

GetWorkload 

$result = $client->getWorkload([/* ... */]);
$promise = $client->getWorkloadAsync([/* ... */]);

Returns information about a workload.

Parameter Syntax

$result = $client->getWorkload([
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Members
workloadName
Required: Yes
Type: string

The name of the workload.

Result Syntax

[
    'workload' => [
        'description' => '<string>',
        'displayName' => '<string>',
        'documentationUrl' => '<string>',
        'iconUrl' => '<string>',
        'status' => 'ACTIVE|INACTIVE|DISABLED|DELETED',
        'statusMessage' => '<string>',
        'workloadName' => '<string>',
    ],
]

Result Details

Members
workload
Type: WorkloadData structure

Information about the workload.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

GetWorkloadDeploymentPattern 

$result = $client->getWorkloadDeploymentPattern([/* ... */]);
$promise = $client->getWorkloadDeploymentPatternAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getWorkloadDeploymentPattern([
    'deploymentPatternName' => '<string>', // REQUIRED
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Members
deploymentPatternName
Required: Yes
Type: string

The name of the deployment pattern.

workloadName
Required: Yes
Type: string

The name of the workload.

Result Syntax

[
    'workloadDeploymentPattern' => [
        'deploymentPatternName' => '<string>',
        'description' => '<string>',
        'displayName' => '<string>',
        'specifications' => [
            [
                'allowedValues' => ['<string>', ...],
                'conditionals' => [
                    [
                        'comparator' => '<string>',
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'description' => '<string>',
                'name' => '<string>',
                'required' => '<string>',
            ],
            // ...
        ],
        'status' => 'ACTIVE|INACTIVE|DISABLED|DELETED',
        'statusMessage' => '<string>',
        'workloadName' => '<string>',
        'workloadVersionName' => '<string>',
    ],
]

Result Details

Members
workloadDeploymentPattern
Type: WorkloadDeploymentPatternData structure

Details about the workload deployment pattern.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

ListDeploymentEvents 

$result = $client->listDeploymentEvents([/* ... */]);
$promise = $client->listDeploymentEventsAsync([/* ... */]);

Lists the events of a deployment.

Parameter Syntax

$result = $client->listDeploymentEvents([
    'deploymentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
deploymentId
Required: Yes
Type: string

The ID of the deployment.

maxResults
Type: int

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
Type: string

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Result Syntax

[
    'deploymentEvents' => [
        [
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'CANCELED|CANCELING|COMPLETED|CREATED|FAILED|IN_PROGRESS|PENDING|TIMED_OUT',
            'statusReason' => '<string>',
            'timestamp' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
deploymentEvents
Type: Array of DeploymentEventDataSummary structures

Lists the deployment events.

nextToken
Type: string

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

ListDeployments 

$result = $client->listDeployments([/* ... */]);
$promise = $client->listDeploymentsAsync([/* ... */]);

Lists the deployments that have been created.

Parameter Syntax

$result = $client->listDeployments([
    'filters' => [
        [
            'name' => 'WORKLOAD_NAME|DEPLOYMENT_STATUS',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
Type: Array of DeploymentFilter structures

Filters to scope the results. The following filters are supported:

  • WORKLOAD_NAME - The name used in deployments.

  • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

maxResults
Type: int

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
Type: string

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Result Syntax

[
    'deployments' => [
        [
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'name' => '<string>',
            'patternName' => '<string>',
            'status' => 'COMPLETED|CREATING|DELETE_IN_PROGRESS|DELETE_INITIATING|DELETE_FAILED|DELETED|FAILED|IN_PROGRESS|VALIDATING',
            'workloadName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
deployments
Type: Array of DeploymentDataSummary structures

Lists the deployments.

nextToken
Type: string

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags associated with a specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

Information about the tags.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

ListWorkloadDeploymentPatterns 

$result = $client->listWorkloadDeploymentPatterns([/* ... */]);
$promise = $client->listWorkloadDeploymentPatternsAsync([/* ... */]);

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

Parameter Syntax

$result = $client->listWorkloadDeploymentPatterns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

workloadName
Required: Yes
Type: string

The name of the workload.

Result Syntax

[
    'nextToken' => '<string>',
    'workloadDeploymentPatterns' => [
        [
            'deploymentPatternName' => '<string>',
            'description' => '<string>',
            'displayName' => '<string>',
            'status' => 'ACTIVE|INACTIVE|DISABLED|DELETED',
            'statusMessage' => '<string>',
            'workloadName' => '<string>',
            'workloadVersionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

workloadDeploymentPatterns
Type: Array of WorkloadDeploymentPatternDataSummary structures

Describes the workload deployment patterns.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

ListWorkloads 

$result = $client->listWorkloads([/* ... */]);
$promise = $client->listWorkloadsAsync([/* ... */]);

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

Parameter Syntax

$result = $client->listWorkloads([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Result Syntax

[
    'nextToken' => '<string>',
    'workloads' => [
        [
            'displayName' => '<string>',
            'workloadName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

workloads
Type: Array of WorkloadDataSummary structures

Information about the workloads.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the given resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

One or more tags to attach to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the given resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
Required: Yes
Type: Array of strings

Keys identifying the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException:

The specified workload or deployment resource can't be found.

Shapes

DeploymentConditionalField

Description

A field that details a condition of the specifications for a deployment.

Members
comparator
Type: string

The comparator of the condition.

Valid values: Equal | NotEqual

name
Type: string

The name of the deployment condition.

value
Type: string

The value of the condition.

DeploymentData

Description

The data associated with a deployment.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment was created.

deletedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment was deleted.

deploymentArn
Type: string

The Amazon Resource Name (ARN) of the deployment.

id
Type: string

The ID of the deployment.

name
Type: string

The name of the deployment.

patternName
Type: string

The pattern name of the deployment.

resourceGroup
Type: string

The resource group of the deployment.

specifications
Type: Associative array of custom strings keys (KeyString) to strings

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.

status
Type: string

The status of the deployment.

tags
Type: Associative array of custom strings keys (TagKey) to strings

Information about the tags attached to a deployment.

workloadName
Type: string

The name of the workload.

DeploymentDataSummary

Description

A summary of the deployment data.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the deployment was created.

id
Type: string

The ID of the deployment.

name
Type: string

The name of the deployment

patternName
Type: string

The name of the workload deployment pattern.

status
Type: string

The status of the deployment.

workloadName
Type: string

The name of the workload.

DeploymentEventDataSummary

Description

A summary of the deployment event data.

Members
description
Type: string

The description of the deployment event.

name
Type: string

The name of the deployment event.

status
Type: string

The status of the deployment event.

statusReason
Type: string

The reason of the deployment event status.

timestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the deployment event.

DeploymentFilter

Description

A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.

Members
name
Type: string

The name of the filter. Filter names are case-sensitive.

values
Type: Array of strings

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

DeploymentSpecificationsField

Description

A field that details a specification of a deployment pattern.

Members
allowedValues
Type: Array of strings

The allowed values of the deployment specification.

conditionals
Type: Array of DeploymentConditionalField structures

The conditionals used for the deployment specification.

description
Type: string

The description of the deployment specification.

name
Type: string

The name of the deployment specification.

required
Type: string

Indicates if the deployment specification is required.

InternalServerException

Description

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

Members
message
Type: string

ResourceLimitException

Description

You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.

Members
message
Type: string

ResourceNotFoundException

Description

The specified workload or deployment resource can't be found.

Members
message
Type: string

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
message
Type: string

WorkloadData

Description

Describes a workload.

Members
description
Type: string

The description of a workload.

displayName
Type: string

The display name of a workload.

documentationUrl
Type: string

The URL of a workload document.

iconUrl
Type: string

The URL of a workload icon.

status
Type: string

The status of a workload.

statusMessage
Type: string

The message about a workload's status.

workloadName
Type: string

The name of the workload.

WorkloadDataSummary

Description

Describes workload data.

Members
displayName
Type: string

The display name of the workload data.

workloadName
Type: string

The name of the workload.

WorkloadDeploymentPatternData

Description

The data that details a workload deployment pattern.

Members
deploymentPatternName
Type: string

The name of the deployment pattern.

description
Type: string

The description of the deployment pattern.

displayName
Type: string

The display name of the deployment pattern.

specifications
Type: Array of DeploymentSpecificationsField structures

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.

status
Type: string

The status of the deployment pattern.

statusMessage
Type: string

The status message of the deployment pattern.

workloadName
Type: string

The workload name of the deployment pattern.

workloadVersionName
Type: string

The workload version name of the deployment pattern.

WorkloadDeploymentPatternDataSummary

Description

Describes a workload deployment pattern.

Members
deploymentPatternName
Type: string

The name of a workload deployment pattern.

description
Type: string

The description of a workload deployment pattern.

displayName
Type: string

The display name of a workload deployment pattern.

status
Type: string

The status of a workload deployment pattern.

statusMessage
Type: string

A message about a workload deployment pattern's status.

workloadName
Type: string

The name of the workload.

workloadVersionName
Type: string

The name of the workload deployment pattern version.