AssignInstance

$result = $client->assignInstance([/* ... */]);
$promise = $client->assignInstanceAsync([/* ... */]);

Assign a registered instance to a layer.

• You can assign registered on-premises instances to any layer type.

• You can assign registered Amazon EC2 instances only to custom layers.

• You cannot use this action with instances that were created with OpsWorks Stacks.

Required Permissions: To use this action, an Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->assignInstance([
    'InstanceId' => '<string>', // REQUIRED
    'LayerIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

AssignVolume

$result = $client->assignVolume([/* ... */]);
$promise = $client->assignVolumeAsync([/* ... */]);

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->assignVolume([
    'InstanceId' => '<string>',
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

AssociateElasticIp

$result = $client->associateElasticIp([/* ... */]);
$promise = $client->associateElasticIpAsync([/* ... */]);

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->associateElasticIp([
    'ElasticIp' => '<string>', // REQUIRED
    'InstanceId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

AttachElasticLoadBalancer

$result = $client->attachElasticLoadBalancer([/* ... */]);
$promise = $client->attachElasticLoadBalancerAsync([/* ... */]);

Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see Elastic Load Balancing.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->attachElasticLoadBalancer([
    'ElasticLoadBalancerName' => '<string>', // REQUIRED
    'LayerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

CloneStack

$result = $client->cloneStack([/* ... */]);
$promise = $client->cloneStackAsync([/* ... */]);

Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->cloneStack([
    'AgentVersion' => '<string>',
    'Attributes' => ['<string>', ...],
    'ChefConfiguration' => [
        'BerkshelfVersion' => '<string>',
        'ManageBerkshelf' => true || false,
    ],
    'CloneAppIds' => ['<string>', ...],
    'ClonePermissions' => true || false,
    'ConfigurationManager' => [
        'Name' => '<string>',
        'Version' => '<string>',
    ],
    'CustomCookbooksSource' => [
        'Password' => '<string>',
        'Revision' => '<string>',
        'SshKey' => '<string>',
        'Type' => 'git|svn|archive|s3',
        'Url' => '<string>',
        'Username' => '<string>',
    ],
    'CustomJson' => '<string>',
    'DefaultAvailabilityZone' => '<string>',
    'DefaultInstanceProfileArn' => '<string>',
    'DefaultOs' => '<string>',
    'DefaultRootDeviceType' => 'ebs|instance-store',
    'DefaultSshKeyName' => '<string>',
    'DefaultSubnetId' => '<string>',
    'HostnameTheme' => '<string>',
    'Name' => '<string>',
    'Region' => '<string>',
    'ServiceRoleArn' => '<string>', // REQUIRED
    'SourceStackId' => '<string>', // REQUIRED
    'UseCustomCookbooks' => true || false,
    'UseOpsworksSecurityGroups' => true || false,
    'VpcId' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->createApp([
    'AppSource' => [
        'Password' => '<string>',
        'Revision' => '<string>',
        'SshKey' => '<string>',
        'Type' => 'git|svn|archive|s3',
        'Url' => '<string>',
        'Username' => '<string>',
    ],
    'Attributes' => ['<string>', ...],
    'DataSources' => [
        [
            'Arn' => '<string>',
            'DatabaseName' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Description' => '<string>',
    'Domains' => ['<string>', ...],
    'EnableSsl' => true || false,
    'Environment' => [
        [
            'Key' => '<string>', // REQUIRED
            'Secure' => true || false,
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'Shortname' => '<string>',
    'SslConfiguration' => [
        'Certificate' => '<string>', // REQUIRED
        'Chain' => '<string>',
        'PrivateKey' => '<string>', // REQUIRED
    ],
    'StackId' => '<string>', // REQUIRED
    'Type' => 'aws-flow-ruby|java|rails|php|nodejs|static|other', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

CreateDeployment

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

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->createDeployment([
    'AppId' => '<string>',
    'Command' => [ // REQUIRED
        'Args' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        'Name' => 'install_dependencies|update_dependencies|update_custom_cookbooks|execute_recipes|configure|setup|deploy|rollback|start|stop|restart|undeploy', // REQUIRED
    ],
    'Comment' => '<string>',
    'CustomJson' => '<string>',
    'InstanceIds' => ['<string>', ...],
    'LayerIds' => ['<string>', ...],
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

CreateInstance

$result = $client->createInstance([/* ... */]);
$promise = $client->createInstanceAsync([/* ... */]);

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->createInstance([
    'AgentVersion' => '<string>',
    'AmiId' => '<string>',
    'Architecture' => 'x86_64|i386',
    'AutoScalingType' => 'load|timer',
    'AvailabilityZone' => '<string>',
    'BlockDeviceMappings' => [
        [
            'DeviceName' => '<string>',
            'Ebs' => [
                'DeleteOnTermination' => true || false,
                'Iops' => <integer>,
                'SnapshotId' => '<string>',
                'VolumeSize' => <integer>,
                'VolumeType' => 'gp2|io1|standard',
            ],
            'NoDevice' => '<string>',
            'VirtualName' => '<string>',
        ],
        // ...
    ],
    'EbsOptimized' => true || false,
    'Hostname' => '<string>',
    'InstallUpdatesOnBoot' => true || false,
    'InstanceType' => '<string>', // REQUIRED
    'LayerIds' => ['<string>', ...], // REQUIRED
    'Os' => '<string>',
    'RootDeviceType' => 'ebs|instance-store',
    'SshKeyName' => '<string>',
    'StackId' => '<string>', // REQUIRED
    'SubnetId' => '<string>',
    'Tenancy' => '<string>',
    'VirtualizationType' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

CreateLayer

$result = $client->createLayer([/* ... */]);
$promise = $client->createLayerAsync([/* ... */]);

Creates a layer. For more information, see How to Create a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->createLayer([
    'Attributes' => ['<string>', ...],
    'AutoAssignElasticIps' => true || false,
    'AutoAssignPublicIps' => true || false,
    'CloudWatchLogsConfiguration' => [
        'Enabled' => true || false,
        'LogStreams' => [
            [
                'BatchCount' => <integer>,
                'BatchSize' => <integer>,
                'BufferDuration' => <integer>,
                'DatetimeFormat' => '<string>',
                'Encoding' => 'ascii|big5|big5hkscs|cp037|cp424|cp437|cp500|cp720|cp737|cp775|cp850|cp852|cp855|cp856|cp857|cp858|cp860|cp861|cp862|cp863|cp864|cp865|cp866|cp869|cp874|cp875|cp932|cp949|cp950|cp1006|cp1026|cp1140|cp1250|cp1251|cp1252|cp1253|cp1254|cp1255|cp1256|cp1257|cp1258|euc_jp|euc_jis_2004|euc_jisx0213|euc_kr|gb2312|gbk|gb18030|hz|iso2022_jp|iso2022_jp_1|iso2022_jp_2|iso2022_jp_2004|iso2022_jp_3|iso2022_jp_ext|iso2022_kr|latin_1|iso8859_2|iso8859_3|iso8859_4|iso8859_5|iso8859_6|iso8859_7|iso8859_8|iso8859_9|iso8859_10|iso8859_13|iso8859_14|iso8859_15|iso8859_16|johab|koi8_r|koi8_u|mac_cyrillic|mac_greek|mac_iceland|mac_latin2|mac_roman|mac_turkish|ptcp154|shift_jis|shift_jis_2004|shift_jisx0213|utf_32|utf_32_be|utf_32_le|utf_16|utf_16_be|utf_16_le|utf_7|utf_8|utf_8_sig',
                'File' => '<string>',
                'FileFingerprintLines' => '<string>',
                'InitialPosition' => 'start_of_file|end_of_file',
                'LogGroupName' => '<string>',
                'MultiLineStartPattern' => '<string>',
                'TimeZone' => 'LOCAL|UTC',
            ],
            // ...
        ],
    ],
    'CustomInstanceProfileArn' => '<string>',
    'CustomJson' => '<string>',
    'CustomRecipes' => [
        'Configure' => ['<string>', ...],
        'Deploy' => ['<string>', ...],
        'Setup' => ['<string>', ...],
        'Shutdown' => ['<string>', ...],
        'Undeploy' => ['<string>', ...],
    ],
    'CustomSecurityGroupIds' => ['<string>', ...],
    'EnableAutoHealing' => true || false,
    'InstallUpdatesOnBoot' => true || false,
    'LifecycleEventConfiguration' => [
        'Shutdown' => [
            'DelayUntilElbConnectionsDrained' => true || false,
            'ExecutionTimeout' => <integer>,
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'Packages' => ['<string>', ...],
    'Shortname' => '<string>', // REQUIRED
    'StackId' => '<string>', // REQUIRED
    'Type' => 'aws-flow-ruby|ecs-cluster|java-app|lb|web|php-app|rails-app|nodejs-app|memcached|db-master|monitoring-master|custom', // REQUIRED
    'UseEbsOptimizedInstances' => true || false,
    'VolumeConfigurations' => [
        [
            'Encrypted' => true || false,
            'Iops' => <integer>,
            'MountPoint' => '<string>', // REQUIRED
            'NumberOfDisks' => <integer>, // REQUIRED
            'RaidLevel' => <integer>,
            'Size' => <integer>, // REQUIRED
            'VolumeType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

CreateStack

$result = $client->createStack([/* ... */]);
$promise = $client->createStackAsync([/* ... */]);

Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->createStack([
    'AgentVersion' => '<string>',
    'Attributes' => ['<string>', ...],
    'ChefConfiguration' => [
        'BerkshelfVersion' => '<string>',
        'ManageBerkshelf' => true || false,
    ],
    'ConfigurationManager' => [
        'Name' => '<string>',
        'Version' => '<string>',
    ],
    'CustomCookbooksSource' => [
        'Password' => '<string>',
        'Revision' => '<string>',
        'SshKey' => '<string>',
        'Type' => 'git|svn|archive|s3',
        'Url' => '<string>',
        'Username' => '<string>',
    ],
    'CustomJson' => '<string>',
    'DefaultAvailabilityZone' => '<string>',
    'DefaultInstanceProfileArn' => '<string>', // REQUIRED
    'DefaultOs' => '<string>',
    'DefaultRootDeviceType' => 'ebs|instance-store',
    'DefaultSshKeyName' => '<string>',
    'DefaultSubnetId' => '<string>',
    'HostnameTheme' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Region' => '<string>', // REQUIRED
    'ServiceRoleArn' => '<string>', // REQUIRED
    'UseCustomCookbooks' => true || false,
    'UseOpsworksSecurityGroups' => true || false,
    'VpcId' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

CreateUserProfile

$result = $client->createUserProfile([/* ... */]);
$promise = $client->createUserProfileAsync([/* ... */]);

Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->createUserProfile([
    'AllowSelfManagement' => true || false,
    'IamUserArn' => '<string>', // REQUIRED
    'SshPublicKey' => '<string>',
    'SshUsername' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes a specified app.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeleteInstance

$result = $client->deleteInstance([/* ... */]);
$promise = $client->deleteInstanceAsync([/* ... */]);

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

For more information, see Deleting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->deleteInstance([
    'DeleteElasticIp' => true || false,
    'DeleteVolumes' => true || false,
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeleteLayer

$result = $client->deleteLayer([/* ... */]);
$promise = $client->deleteLayerAsync([/* ... */]);

Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeleteStack

$result = $client->deleteStack([/* ... */]);
$promise = $client->deleteStackAsync([/* ... */]);

Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeleteUserProfile

$result = $client->deleteUserProfile([/* ... */]);
$promise = $client->deleteUserProfileAsync([/* ... */]);

Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeregisterEcsCluster

$result = $client->deregisterEcsCluster([/* ... */]);
$promise = $client->deregisterEcsClusterAsync([/* ... */]);

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeregisterElasticIp

$result = $client->deregisterElasticIp([/* ... */]);
$promise = $client->deregisterElasticIpAsync([/* ... */]);

Deregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeregisterInstance

$result = $client->deregisterInstance([/* ... */]);
$promise = $client->deregisterInstanceAsync([/* ... */]);

Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeregisterRdsDbInstance

$result = $client->deregisterRdsDbInstance([/* ... */]);
$promise = $client->deregisterRdsDbInstanceAsync([/* ... */]);

Deregisters an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DeregisterVolume

$result = $client->deregisterVolume([/* ... */]);
$promise = $client->deregisterVolumeAsync([/* ... */]);

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeAgentVersions

$result = $client->describeAgentVersions([/* ... */]);
$promise = $client->describeAgentVersionsAsync([/* ... */]);

Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

Parameter Syntax

$result = $client->describeAgentVersions([
    'ConfigurationManager' => [
        'Name' => '<string>',
        'Version' => '<string>',
    ],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AgentVersions' => [
        [
            'ConfigurationManager' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeApps

$result = $client->describeApps([/* ... */]);
$promise = $client->describeAppsAsync([/* ... */]);

Requests a description of a specified set of apps.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeApps([
    'AppIds' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Apps' => [
        [
            'AppId' => '<string>',
            'AppSource' => [
                'Password' => '<string>',
                'Revision' => '<string>',
                'SshKey' => '<string>',
                'Type' => 'git|svn|archive|s3',
                'Url' => '<string>',
                'Username' => '<string>',
            ],
            'Attributes' => ['<string>', ...],
            'CreatedAt' => '<string>',
            'DataSources' => [
                [
                    'Arn' => '<string>',
                    'DatabaseName' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Description' => '<string>',
            'Domains' => ['<string>', ...],
            'EnableSsl' => true || false,
            'Environment' => [
                [
                    'Key' => '<string>',
                    'Secure' => true || false,
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'Shortname' => '<string>',
            'SslConfiguration' => [
                'Certificate' => '<string>',
                'Chain' => '<string>',
                'PrivateKey' => '<string>',
            ],
            'StackId' => '<string>',
            'Type' => 'aws-flow-ruby|java|rails|php|nodejs|static|other',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeCommands

$result = $client->describeCommands([/* ... */]);
$promise = $client->describeCommandsAsync([/* ... */]);

Describes the results of specified commands.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeCommands([
    'CommandIds' => ['<string>', ...],
    'DeploymentId' => '<string>',
    'InstanceId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Commands' => [
        [
            'AcknowledgedAt' => '<string>',
            'CommandId' => '<string>',
            'CompletedAt' => '<string>',
            'CreatedAt' => '<string>',
            'DeploymentId' => '<string>',
            'ExitCode' => <integer>,
            'InstanceId' => '<string>',
            'LogUrl' => '<string>',
            'Status' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeDeployments

$result = $client->describeDeployments([/* ... */]);
$promise = $client->describeDeploymentsAsync([/* ... */]);

Requests a description of a specified set of deployments.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeDeployments([
    'AppId' => '<string>',
    'DeploymentIds' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Deployments' => [
        [
            'AppId' => '<string>',
            'Command' => [
                'Args' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'Name' => 'install_dependencies|update_dependencies|update_custom_cookbooks|execute_recipes|configure|setup|deploy|rollback|start|stop|restart|undeploy',
            ],
            'Comment' => '<string>',
            'CompletedAt' => '<string>',
            'CreatedAt' => '<string>',
            'CustomJson' => '<string>',
            'DeploymentId' => '<string>',
            'Duration' => <integer>,
            'IamUserArn' => '<string>',
            'InstanceIds' => ['<string>', ...],
            'StackId' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeEcsClusters

$result = $client->describeEcsClusters([/* ... */]);
$promise = $client->describeEcsClustersAsync([/* ... */]);

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Parameter Syntax

$result = $client->describeEcsClusters([
    'EcsClusterArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EcsClusters' => [
        [
            'EcsClusterArn' => '<string>',
            'EcsClusterName' => '<string>',
            'RegisteredAt' => '<string>',
            'StackId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeElasticIps

$result = $client->describeElasticIps([/* ... */]);
$promise = $client->describeElasticIpsAsync([/* ... */]);

Describes Elastic IP addresses.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeElasticIps([
    'InstanceId' => '<string>',
    'Ips' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ElasticIps' => [
        [
            'Domain' => '<string>',
            'InstanceId' => '<string>',
            'Ip' => '<string>',
            'Name' => '<string>',
            'Region' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeElasticLoadBalancers

$result = $client->describeElasticLoadBalancers([/* ... */]);
$promise = $client->describeElasticLoadBalancersAsync([/* ... */]);

Describes a stack's Elastic Load Balancing instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeElasticLoadBalancers([
    'LayerIds' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ElasticLoadBalancers' => [
        [
            'AvailabilityZones' => ['<string>', ...],
            'DnsName' => '<string>',
            'Ec2InstanceIds' => ['<string>', ...],
            'ElasticLoadBalancerName' => '<string>',
            'LayerId' => '<string>',
            'Region' => '<string>',
            'StackId' => '<string>',
            'SubnetIds' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeInstances

$result = $client->describeInstances([/* ... */]);
$promise = $client->describeInstancesAsync([/* ... */]);

Requests a description of a set of instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeInstances([
    'InstanceIds' => ['<string>', ...],
    'LayerId' => '<string>',
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Instances' => [
        [
            'AgentVersion' => '<string>',
            'AmiId' => '<string>',
            'Architecture' => 'x86_64|i386',
            'Arn' => '<string>',
            'AutoScalingType' => 'load|timer',
            'AvailabilityZone' => '<string>',
            'BlockDeviceMappings' => [
                [
                    'DeviceName' => '<string>',
                    'Ebs' => [
                        'DeleteOnTermination' => true || false,
                        'Iops' => <integer>,
                        'SnapshotId' => '<string>',
                        'VolumeSize' => <integer>,
                        'VolumeType' => 'gp2|io1|standard',
                    ],
                    'NoDevice' => '<string>',
                    'VirtualName' => '<string>',
                ],
                // ...
            ],
            'CreatedAt' => '<string>',
            'EbsOptimized' => true || false,
            'Ec2InstanceId' => '<string>',
            'EcsClusterArn' => '<string>',
            'EcsContainerInstanceArn' => '<string>',
            'ElasticIp' => '<string>',
            'Hostname' => '<string>',
            'InfrastructureClass' => '<string>',
            'InstallUpdatesOnBoot' => true || false,
            'InstanceId' => '<string>',
            'InstanceProfileArn' => '<string>',
            'InstanceType' => '<string>',
            'LastServiceErrorId' => '<string>',
            'LayerIds' => ['<string>', ...],
            'Os' => '<string>',
            'Platform' => '<string>',
            'PrivateDns' => '<string>',
            'PrivateIp' => '<string>',
            'PublicDns' => '<string>',
            'PublicIp' => '<string>',
            'RegisteredBy' => '<string>',
            'ReportedAgentVersion' => '<string>',
            'ReportedOs' => [
                'Family' => '<string>',
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'RootDeviceType' => 'ebs|instance-store',
            'RootDeviceVolumeId' => '<string>',
            'SecurityGroupIds' => ['<string>', ...],
            'SshHostDsaKeyFingerprint' => '<string>',
            'SshHostRsaKeyFingerprint' => '<string>',
            'SshKeyName' => '<string>',
            'StackId' => '<string>',
            'Status' => '<string>',
            'SubnetId' => '<string>',
            'Tenancy' => '<string>',
            'VirtualizationType' => 'paravirtual|hvm',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeLayers

$result = $client->describeLayers([/* ... */]);
$promise = $client->describeLayersAsync([/* ... */]);

Requests a description of one or more layers in a specified stack.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeLayers([
    'LayerIds' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Layers' => [
        [
            'Arn' => '<string>',
            'Attributes' => ['<string>', ...],
            'AutoAssignElasticIps' => true || false,
            'AutoAssignPublicIps' => true || false,
            'CloudWatchLogsConfiguration' => [
                'Enabled' => true || false,
                'LogStreams' => [
                    [
                        'BatchCount' => <integer>,
                        'BatchSize' => <integer>,
                        'BufferDuration' => <integer>,
                        'DatetimeFormat' => '<string>',
                        'Encoding' => 'ascii|big5|big5hkscs|cp037|cp424|cp437|cp500|cp720|cp737|cp775|cp850|cp852|cp855|cp856|cp857|cp858|cp860|cp861|cp862|cp863|cp864|cp865|cp866|cp869|cp874|cp875|cp932|cp949|cp950|cp1006|cp1026|cp1140|cp1250|cp1251|cp1252|cp1253|cp1254|cp1255|cp1256|cp1257|cp1258|euc_jp|euc_jis_2004|euc_jisx0213|euc_kr|gb2312|gbk|gb18030|hz|iso2022_jp|iso2022_jp_1|iso2022_jp_2|iso2022_jp_2004|iso2022_jp_3|iso2022_jp_ext|iso2022_kr|latin_1|iso8859_2|iso8859_3|iso8859_4|iso8859_5|iso8859_6|iso8859_7|iso8859_8|iso8859_9|iso8859_10|iso8859_13|iso8859_14|iso8859_15|iso8859_16|johab|koi8_r|koi8_u|mac_cyrillic|mac_greek|mac_iceland|mac_latin2|mac_roman|mac_turkish|ptcp154|shift_jis|shift_jis_2004|shift_jisx0213|utf_32|utf_32_be|utf_32_le|utf_16|utf_16_be|utf_16_le|utf_7|utf_8|utf_8_sig',
                        'File' => '<string>',
                        'FileFingerprintLines' => '<string>',
                        'InitialPosition' => 'start_of_file|end_of_file',
                        'LogGroupName' => '<string>',
                        'MultiLineStartPattern' => '<string>',
                        'TimeZone' => 'LOCAL|UTC',
                    ],
                    // ...
                ],
            ],
            'CreatedAt' => '<string>',
            'CustomInstanceProfileArn' => '<string>',
            'CustomJson' => '<string>',
            'CustomRecipes' => [
                'Configure' => ['<string>', ...],
                'Deploy' => ['<string>', ...],
                'Setup' => ['<string>', ...],
                'Shutdown' => ['<string>', ...],
                'Undeploy' => ['<string>', ...],
            ],
            'CustomSecurityGroupIds' => ['<string>', ...],
            'DefaultRecipes' => [
                'Configure' => ['<string>', ...],
                'Deploy' => ['<string>', ...],
                'Setup' => ['<string>', ...],
                'Shutdown' => ['<string>', ...],
                'Undeploy' => ['<string>', ...],
            ],
            'DefaultSecurityGroupNames' => ['<string>', ...],
            'EnableAutoHealing' => true || false,
            'InstallUpdatesOnBoot' => true || false,
            'LayerId' => '<string>',
            'LifecycleEventConfiguration' => [
                'Shutdown' => [
                    'DelayUntilElbConnectionsDrained' => true || false,
                    'ExecutionTimeout' => <integer>,
                ],
            ],
            'Name' => '<string>',
            'Packages' => ['<string>', ...],
            'Shortname' => '<string>',
            'StackId' => '<string>',
            'Type' => 'aws-flow-ruby|ecs-cluster|java-app|lb|web|php-app|rails-app|nodejs-app|memcached|db-master|monitoring-master|custom',
            'UseEbsOptimizedInstances' => true || false,
            'VolumeConfigurations' => [
                [
                    'Encrypted' => true || false,
                    'Iops' => <integer>,
                    'MountPoint' => '<string>',
                    'NumberOfDisks' => <integer>,
                    'RaidLevel' => <integer>,
                    'Size' => <integer>,
                    'VolumeType' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeLoadBasedAutoScaling

$result = $client->describeLoadBasedAutoScaling([/* ... */]);
$promise = $client->describeLoadBasedAutoScalingAsync([/* ... */]);

Describes load-based auto scaling configurations for specified layers.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeLoadBasedAutoScaling([
    'LayerIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LoadBasedAutoScalingConfigurations' => [
        [
            'DownScaling' => [
                'Alarms' => ['<string>', ...],
                'CpuThreshold' => <float>,
                'IgnoreMetricsTime' => <integer>,
                'InstanceCount' => <integer>,
                'LoadThreshold' => <float>,
                'MemoryThreshold' => <float>,
                'ThresholdsWaitTime' => <integer>,
            ],
            'Enable' => true || false,
            'LayerId' => '<string>',
            'UpScaling' => [
                'Alarms' => ['<string>', ...],
                'CpuThreshold' => <float>,
                'IgnoreMetricsTime' => <integer>,
                'InstanceCount' => <integer>,
                'LoadThreshold' => <float>,
                'MemoryThreshold' => <float>,
                'ThresholdsWaitTime' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeMyUserProfile

$result = $client->describeMyUserProfile([/* ... */]);
$promise = $client->describeMyUserProfileAsync([/* ... */]);

Describes a user's SSH information.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeMyUserProfile([
]);

Parameter Details

Result Syntax

[
    'UserProfile' => [
        'IamUserArn' => '<string>',
        'Name' => '<string>',
        'SshPublicKey' => '<string>',
        'SshUsername' => '<string>',
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeOperatingSystems

$result = $client->describeOperatingSystems([/* ... */]);
$promise = $client->describeOperatingSystemsAsync([/* ... */]);

Describes the operating systems that are supported by OpsWorks Stacks.

Parameter Syntax

$result = $client->describeOperatingSystems([
]);

Parameter Details

Result Syntax

[
    'OperatingSystems' => [
        [
            'ConfigurationManagers' => [
                [
                    'Name' => '<string>',
                    'Version' => '<string>',
                ],
                // ...
            ],
            'Id' => '<string>',
            'Name' => '<string>',
            'ReportedName' => '<string>',
            'ReportedVersion' => '<string>',
            'Supported' => true || false,
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribePermissions

$result = $client->describePermissions([/* ... */]);
$promise = $client->describePermissionsAsync([/* ... */]);

Describes the permissions for a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describePermissions([
    'IamUserArn' => '<string>',
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Permissions' => [
        [
            'AllowSsh' => true || false,
            'AllowSudo' => true || false,
            'IamUserArn' => '<string>',
            'Level' => '<string>',
            'StackId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeRaidArrays

$result = $client->describeRaidArrays([/* ... */]);
$promise = $client->describeRaidArraysAsync([/* ... */]);

Describe an instance's RAID arrays.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeRaidArrays([
    'InstanceId' => '<string>',
    'RaidArrayIds' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'RaidArrays' => [
        [
            'AvailabilityZone' => '<string>',
            'CreatedAt' => '<string>',
            'Device' => '<string>',
            'InstanceId' => '<string>',
            'Iops' => <integer>,
            'MountPoint' => '<string>',
            'Name' => '<string>',
            'NumberOfDisks' => <integer>,
            'RaidArrayId' => '<string>',
            'RaidLevel' => <integer>,
            'Size' => <integer>,
            'StackId' => '<string>',
            'VolumeType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeRdsDbInstances

$result = $client->describeRdsDbInstances([/* ... */]);
$promise = $client->describeRdsDbInstancesAsync([/* ... */]);

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Parameter Syntax

$result = $client->describeRdsDbInstances([
    'RdsDbInstanceArns' => ['<string>', ...],
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RdsDbInstances' => [
        [
            'Address' => '<string>',
            'DbInstanceIdentifier' => '<string>',
            'DbPassword' => '<string>',
            'DbUser' => '<string>',
            'Engine' => '<string>',
            'MissingOnRds' => true || false,
            'RdsDbInstanceArn' => '<string>',
            'Region' => '<string>',
            'StackId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeServiceErrors

$result = $client->describeServiceErrors([/* ... */]);
$promise = $client->describeServiceErrorsAsync([/* ... */]);

Describes OpsWorks Stacks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Parameter Syntax

$result = $client->describeServiceErrors([
    'InstanceId' => '<string>',
    'ServiceErrorIds' => ['<string>', ...],
    'StackId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ServiceErrors' => [
        [
            'CreatedAt' => '<string>',
            'InstanceId' => '<string>',
            'Message' => '<string>',
            'ServiceErrorId' => '<string>',
            'StackId' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeStackProvisioningParameters

$result = $client->describeStackProvisioningParameters([/* ... */]);
$promise = $client->describeStackProvisioningParametersAsync([/* ... */]);

Requests a description of a stack's provisioning parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AgentInstallerUrl' => '<string>',
    'Parameters' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeStackSummary

$result = $client->describeStackSummary([/* ... */]);
$promise = $client->describeStackSummaryAsync([/* ... */]);

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'StackSummary' => [
        'AppsCount' => <integer>,
        'Arn' => '<string>',
        'InstancesCount' => [
            'Assigning' => <integer>,
            'Booting' => <integer>,
            'ConnectionLost' => <integer>,
            'Deregistering' => <integer>,
            'Online' => <integer>,
            'Pending' => <integer>,
            'Rebooting' => <integer>,
            'Registered' => <integer>,
            'Registering' => <integer>,
            'Requested' => <integer>,
            'RunningSetup' => <integer>,
            'SetupFailed' => <integer>,
            'ShuttingDown' => <integer>,
            'StartFailed' => <integer>,
            'StopFailed' => <integer>,
            'Stopped' => <integer>,
            'Stopping' => <integer>,
            'Terminated' => <integer>,
            'Terminating' => <integer>,
            'Unassigning' => <integer>,
        ],
        'LayersCount' => <integer>,
        'Name' => '<string>',
        'StackId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeStacks

$result = $client->describeStacks([/* ... */]);
$promise = $client->describeStacksAsync([/* ... */]);

Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeStacks([
    'StackIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Stacks' => [
        [
            'AgentVersion' => '<string>',
            'Arn' => '<string>',
            'Attributes' => ['<string>', ...],
            'ChefConfiguration' => [
                'BerkshelfVersion' => '<string>',
                'ManageBerkshelf' => true || false,
            ],
            'ConfigurationManager' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'CreatedAt' => '<string>',
            'CustomCookbooksSource' => [
                'Password' => '<string>',
                'Revision' => '<string>',
                'SshKey' => '<string>',
                'Type' => 'git|svn|archive|s3',
                'Url' => '<string>',
                'Username' => '<string>',
            ],
            'CustomJson' => '<string>',
            'DefaultAvailabilityZone' => '<string>',
            'DefaultInstanceProfileArn' => '<string>',
            'DefaultOs' => '<string>',
            'DefaultRootDeviceType' => 'ebs|instance-store',
            'DefaultSshKeyName' => '<string>',
            'DefaultSubnetId' => '<string>',
            'HostnameTheme' => '<string>',
            'Name' => '<string>',
            'Region' => '<string>',
            'ServiceRoleArn' => '<string>',
            'StackId' => '<string>',
            'UseCustomCookbooks' => true || false,
            'UseOpsworksSecurityGroups' => true || false,
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeTimeBasedAutoScaling

$result = $client->describeTimeBasedAutoScaling([/* ... */]);
$promise = $client->describeTimeBasedAutoScalingAsync([/* ... */]);

Describes time-based auto scaling configurations for specified instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeTimeBasedAutoScaling([
    'InstanceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TimeBasedAutoScalingConfigurations' => [
        [
            'AutoScalingSchedule' => [
                'Friday' => ['<string>', ...],
                'Monday' => ['<string>', ...],
                'Saturday' => ['<string>', ...],
                'Sunday' => ['<string>', ...],
                'Thursday' => ['<string>', ...],
                'Tuesday' => ['<string>', ...],
                'Wednesday' => ['<string>', ...],
            ],
            'InstanceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeUserProfiles

$result = $client->describeUserProfiles([/* ... */]);
$promise = $client->describeUserProfilesAsync([/* ... */]);

Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeUserProfiles([
    'IamUserArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'UserProfiles' => [
        [
            'AllowSelfManagement' => true || false,
            'IamUserArn' => '<string>',
            'Name' => '<string>',
            'SshPublicKey' => '<string>',
            'SshUsername' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DescribeVolumes

$result = $client->describeVolumes([/* ... */]);
$promise = $client->describeVolumesAsync([/* ... */]);

Describes an instance's Amazon EBS volumes.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->describeVolumes([
    'InstanceId' => '<string>',
    'RaidArrayId' => '<string>',
    'StackId' => '<string>',
    'VolumeIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Volumes' => [
        [
            'AvailabilityZone' => '<string>',
            'Device' => '<string>',
            'Ec2VolumeId' => '<string>',
            'Encrypted' => true || false,
            'InstanceId' => '<string>',
            'Iops' => <integer>,
            'MountPoint' => '<string>',
            'Name' => '<string>',
            'RaidArrayId' => '<string>',
            'Region' => '<string>',
            'Size' => <integer>,
            'Status' => '<string>',
            'VolumeId' => '<string>',
            'VolumeType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

DetachElasticLoadBalancer

$result = $client->detachElasticLoadBalancer([/* ... */]);
$promise = $client->detachElasticLoadBalancerAsync([/* ... */]);

Detaches a specified Elastic Load Balancing instance from its layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->detachElasticLoadBalancer([
    'ElasticLoadBalancerName' => '<string>', // REQUIRED
    'LayerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Indicates that a resource was not found.

DisassociateElasticIp

$result = $client->disassociateElasticIp([/* ... */]);
$promise = $client->disassociateElasticIpAsync([/* ... */]);

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

GetHostnameSuggestion

$result = $client->getHostnameSuggestion([/* ... */]);
$promise = $client->getHostnameSuggestionAsync([/* ... */]);

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Hostname' => '<string>',
    'LayerId' => '<string>',
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

GrantAccess

$result = $client->grantAccess([/* ... */]);
$promise = $client->grantAccessAsync([/* ... */]);

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

Parameter Syntax

$result = $client->grantAccess([
    'InstanceId' => '<string>', // REQUIRED
    'ValidForInMinutes' => <integer>,
]);

Parameter Details

Result Syntax

[
    'TemporaryCredential' => [
        'InstanceId' => '<string>',
        'Password' => '<string>',
        'Username' => '<string>',
        'ValidForInMinutes' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

ListTags

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Returns a list of tags that are applied to the specified stack or layer.

Parameter Syntax

$result = $client->listTags([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

RebootInstance

$result = $client->rebootInstance([/* ... */]);
$promise = $client->rebootInstanceAsync([/* ... */]);

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

RegisterEcsCluster

$result = $client->registerEcsCluster([/* ... */]);
$promise = $client->registerEcsClusterAsync([/* ... */]);

Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->registerEcsCluster([
    'EcsClusterArn' => '<string>', // REQUIRED
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

RegisterElasticIp

$result = $client->registerElasticIp([/* ... */]);
$promise = $client->registerElasticIpAsync([/* ... */]);

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->registerElasticIp([
    'ElasticIp' => '<string>', // REQUIRED
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

RegisterInstance

$result = $client->registerInstance([/* ... */]);
$promise = $client->registerInstanceAsync([/* ... */]);

Registers instances that were created outside of OpsWorks Stacks with a specified stack.

Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->registerInstance([
    'Hostname' => '<string>',
    'InstanceIdentity' => [
        'Document' => '<string>',
        'Signature' => '<string>',
    ],
    'PrivateIp' => '<string>',
    'PublicIp' => '<string>',
    'RsaPublicKey' => '<string>',
    'RsaPublicKeyFingerprint' => '<string>',
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

RegisterRdsDbInstance

$result = $client->registerRdsDbInstance([/* ... */]);
$promise = $client->registerRdsDbInstanceAsync([/* ... */]);

Registers an Amazon RDS instance with a stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->registerRdsDbInstance([
    'DbPassword' => '<string>', // REQUIRED
    'DbUser' => '<string>', // REQUIRED
    'RdsDbInstanceArn' => '<string>', // REQUIRED
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

RegisterVolume

$result = $client->registerVolume([/* ... */]);
$promise = $client->registerVolumeAsync([/* ... */]);

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->registerVolume([
    'Ec2VolumeId' => '<string>',
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

SetLoadBasedAutoScaling

$result = $client->setLoadBasedAutoScaling([/* ... */]);
$promise = $client->setLoadBasedAutoScalingAsync([/* ... */]);

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->setLoadBasedAutoScaling([
    'DownScaling' => [
        'Alarms' => ['<string>', ...],
        'CpuThreshold' => <float>,
        'IgnoreMetricsTime' => <integer>,
        'InstanceCount' => <integer>,
        'LoadThreshold' => <float>,
        'MemoryThreshold' => <float>,
        'ThresholdsWaitTime' => <integer>,
    ],
    'Enable' => true || false,
    'LayerId' => '<string>', // REQUIRED
    'UpScaling' => [
        'Alarms' => ['<string>', ...],
        'CpuThreshold' => <float>,
        'IgnoreMetricsTime' => <integer>,
        'InstanceCount' => <integer>,
        'LoadThreshold' => <float>,
        'MemoryThreshold' => <float>,
        'ThresholdsWaitTime' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

SetPermission

$result = $client->setPermission([/* ... */]);
$promise = $client->setPermissionAsync([/* ... */]);

Specifies a user's permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->setPermission([
    'AllowSsh' => true || false,
    'AllowSudo' => true || false,
    'IamUserArn' => '<string>', // REQUIRED
    'Level' => '<string>',
    'StackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

SetTimeBasedAutoScaling

$result = $client->setTimeBasedAutoScaling([/* ... */]);
$promise = $client->setTimeBasedAutoScalingAsync([/* ... */]);

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->setTimeBasedAutoScaling([
    'AutoScalingSchedule' => [
        'Friday' => ['<string>', ...],
        'Monday' => ['<string>', ...],
        'Saturday' => ['<string>', ...],
        'Sunday' => ['<string>', ...],
        'Thursday' => ['<string>', ...],
        'Tuesday' => ['<string>', ...],
        'Wednesday' => ['<string>', ...],
    ],
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

StartInstance

$result = $client->startInstance([/* ... */]);
$promise = $client->startInstanceAsync([/* ... */]);

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

StartStack

$result = $client->startStack([/* ... */]);
$promise = $client->startStackAsync([/* ... */]);

Starts a stack's instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

StopInstance

$result = $client->stopInstance([/* ... */]);
$promise = $client->stopInstanceAsync([/* ... */]);

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->stopInstance([
    'Force' => true || false,
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

StopStack

$result = $client->stopStack([/* ... */]);
$promise = $client->stopStackAsync([/* ... */]);

Stops a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

TagResource

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

Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see Tags in the OpsWorks User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UnassignInstance

$result = $client->unassignInstance([/* ... */]);
$promise = $client->unassignInstanceAsync([/* ... */]);

Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with OpsWorks Stacks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UnassignVolume

$result = $client->unassignVolume([/* ... */]);
$promise = $client->unassignVolumeAsync([/* ... */]);

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UntagResource

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

Removes tags from a specified stack or layer.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateApp

$result = $client->updateApp([/* ... */]);
$promise = $client->updateAppAsync([/* ... */]);

Updates a specified app.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateApp([
    'AppId' => '<string>', // REQUIRED
    'AppSource' => [
        'Password' => '<string>',
        'Revision' => '<string>',
        'SshKey' => '<string>',
        'Type' => 'git|svn|archive|s3',
        'Url' => '<string>',
        'Username' => '<string>',
    ],
    'Attributes' => ['<string>', ...],
    'DataSources' => [
        [
            'Arn' => '<string>',
            'DatabaseName' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Description' => '<string>',
    'Domains' => ['<string>', ...],
    'EnableSsl' => true || false,
    'Environment' => [
        [
            'Key' => '<string>', // REQUIRED
            'Secure' => true || false,
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>',
    'SslConfiguration' => [
        'Certificate' => '<string>', // REQUIRED
        'Chain' => '<string>',
        'PrivateKey' => '<string>', // REQUIRED
    ],
    'Type' => 'aws-flow-ruby|java|rails|php|nodejs|static|other',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateElasticIp

$result = $client->updateElasticIp([/* ... */]);
$promise = $client->updateElasticIpAsync([/* ... */]);

Updates a registered Elastic IP address's name. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateElasticIp([
    'ElasticIp' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateInstance

$result = $client->updateInstance([/* ... */]);
$promise = $client->updateInstanceAsync([/* ... */]);

Updates a specified instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateInstance([
    'AgentVersion' => '<string>',
    'AmiId' => '<string>',
    'Architecture' => 'x86_64|i386',
    'AutoScalingType' => 'load|timer',
    'EbsOptimized' => true || false,
    'Hostname' => '<string>',
    'InstallUpdatesOnBoot' => true || false,
    'InstanceId' => '<string>', // REQUIRED
    'InstanceType' => '<string>',
    'LayerIds' => ['<string>', ...],
    'Os' => '<string>',
    'SshKeyName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateLayer

$result = $client->updateLayer([/* ... */]);
$promise = $client->updateLayerAsync([/* ... */]);

Updates a specified layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateLayer([
    'Attributes' => ['<string>', ...],
    'AutoAssignElasticIps' => true || false,
    'AutoAssignPublicIps' => true || false,
    'CloudWatchLogsConfiguration' => [
        'Enabled' => true || false,
        'LogStreams' => [
            [
                'BatchCount' => <integer>,
                'BatchSize' => <integer>,
                'BufferDuration' => <integer>,
                'DatetimeFormat' => '<string>',
                'Encoding' => 'ascii|big5|big5hkscs|cp037|cp424|cp437|cp500|cp720|cp737|cp775|cp850|cp852|cp855|cp856|cp857|cp858|cp860|cp861|cp862|cp863|cp864|cp865|cp866|cp869|cp874|cp875|cp932|cp949|cp950|cp1006|cp1026|cp1140|cp1250|cp1251|cp1252|cp1253|cp1254|cp1255|cp1256|cp1257|cp1258|euc_jp|euc_jis_2004|euc_jisx0213|euc_kr|gb2312|gbk|gb18030|hz|iso2022_jp|iso2022_jp_1|iso2022_jp_2|iso2022_jp_2004|iso2022_jp_3|iso2022_jp_ext|iso2022_kr|latin_1|iso8859_2|iso8859_3|iso8859_4|iso8859_5|iso8859_6|iso8859_7|iso8859_8|iso8859_9|iso8859_10|iso8859_13|iso8859_14|iso8859_15|iso8859_16|johab|koi8_r|koi8_u|mac_cyrillic|mac_greek|mac_iceland|mac_latin2|mac_roman|mac_turkish|ptcp154|shift_jis|shift_jis_2004|shift_jisx0213|utf_32|utf_32_be|utf_32_le|utf_16|utf_16_be|utf_16_le|utf_7|utf_8|utf_8_sig',
                'File' => '<string>',
                'FileFingerprintLines' => '<string>',
                'InitialPosition' => 'start_of_file|end_of_file',
                'LogGroupName' => '<string>',
                'MultiLineStartPattern' => '<string>',
                'TimeZone' => 'LOCAL|UTC',
            ],
            // ...
        ],
    ],
    'CustomInstanceProfileArn' => '<string>',
    'CustomJson' => '<string>',
    'CustomRecipes' => [
        'Configure' => ['<string>', ...],
        'Deploy' => ['<string>', ...],
        'Setup' => ['<string>', ...],
        'Shutdown' => ['<string>', ...],
        'Undeploy' => ['<string>', ...],
    ],
    'CustomSecurityGroupIds' => ['<string>', ...],
    'EnableAutoHealing' => true || false,
    'InstallUpdatesOnBoot' => true || false,
    'LayerId' => '<string>', // REQUIRED
    'LifecycleEventConfiguration' => [
        'Shutdown' => [
            'DelayUntilElbConnectionsDrained' => true || false,
            'ExecutionTimeout' => <integer>,
        ],
    ],
    'Name' => '<string>',
    'Packages' => ['<string>', ...],
    'Shortname' => '<string>',
    'UseEbsOptimizedInstances' => true || false,
    'VolumeConfigurations' => [
        [
            'Encrypted' => true || false,
            'Iops' => <integer>,
            'MountPoint' => '<string>', // REQUIRED
            'NumberOfDisks' => <integer>, // REQUIRED
            'RaidLevel' => <integer>,
            'Size' => <integer>, // REQUIRED
            'VolumeType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateMyUserProfile

$result = $client->updateMyUserProfile([/* ... */]);
$promise = $client->updateMyUserProfileAsync([/* ... */]);

Updates a user's SSH public key.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateMyUserProfile([
    'SshPublicKey' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

UpdateRdsDbInstance

$result = $client->updateRdsDbInstance([/* ... */]);
$promise = $client->updateRdsDbInstanceAsync([/* ... */]);

Updates an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateRdsDbInstance([
    'DbPassword' => '<string>',
    'DbUser' => '<string>',
    'RdsDbInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateStack

$result = $client->updateStack([/* ... */]);
$promise = $client->updateStackAsync([/* ... */]);

Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateStack([
    'AgentVersion' => '<string>',
    'Attributes' => ['<string>', ...],
    'ChefConfiguration' => [
        'BerkshelfVersion' => '<string>',
        'ManageBerkshelf' => true || false,
    ],
    'ConfigurationManager' => [
        'Name' => '<string>',
        'Version' => '<string>',
    ],
    'CustomCookbooksSource' => [
        'Password' => '<string>',
        'Revision' => '<string>',
        'SshKey' => '<string>',
        'Type' => 'git|svn|archive|s3',
        'Url' => '<string>',
        'Username' => '<string>',
    ],
    'CustomJson' => '<string>',
    'DefaultAvailabilityZone' => '<string>',
    'DefaultInstanceProfileArn' => '<string>',
    'DefaultOs' => '<string>',
    'DefaultRootDeviceType' => 'ebs|instance-store',
    'DefaultSshKeyName' => '<string>',
    'DefaultSubnetId' => '<string>',
    'HostnameTheme' => '<string>',
    'Name' => '<string>',
    'ServiceRoleArn' => '<string>',
    'StackId' => '<string>', // REQUIRED
    'UseCustomCookbooks' => true || false,
    'UseOpsworksSecurityGroups' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateUserProfile

$result = $client->updateUserProfile([/* ... */]);
$promise = $client->updateUserProfileAsync([/* ... */]);

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateUserProfile([
    'AllowSelfManagement' => true || false,
    'IamUserArn' => '<string>', // REQUIRED
    'SshPublicKey' => '<string>',
    'SshUsername' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.

UpdateVolume

$result = $client->updateVolume([/* ... */]);
$promise = $client->updateVolumeAsync([/* ... */]);

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameter Syntax

$result = $client->updateVolume([
    'MountPoint' => '<string>',
    'Name' => '<string>',
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Indicates that a request was not valid.

ResourceNotFoundException:

Indicates that a resource was not found.