@Generated(value="software.amazon.awssdk:codegen") public interface OpsWorksClient extends SdkClient, SdkAutoCloseable
builder() method.
Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
opsworks.us-east-1.amazonaws.com
opsworks.us-east-2.amazonaws.com
opsworks.us-west-1.amazonaws.com
opsworks.us-west-2.amazonaws.com
opsworks.eu-west-1.amazonaws.com
opsworks.eu-west-2.amazonaws.com
opsworks.eu-central-1.amazonaws.com
opsworks.ap-northeast-1.amazonaws.com
opsworks.ap-northeast-2.amazonaws.com
opsworks.ap-south-1.amazonaws.com
opsworks.ap-southeast-1.amazonaws.com
opsworks.ap-southeast-2.amazonaws.com
opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the
ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux
stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssignInstanceResponse |
assignInstance(AssignInstanceRequest assignInstanceRequest)
Assign a registered instance to a layer.
|
default AssignInstanceResponse |
assignInstance(Consumer<AssignInstanceRequest.Builder> assignInstanceRequest)
Assign a registered instance to a layer.
|
default AssignVolumeResponse |
assignVolume(AssignVolumeRequest assignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
default AssignVolumeResponse |
assignVolume(Consumer<AssignVolumeRequest.Builder> assignVolumeRequest)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
default AssociateElasticIpResponse |
associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest)
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
default AssociateElasticIpResponse |
associateElasticIp(Consumer<AssociateElasticIpRequest.Builder> associateElasticIpRequest)
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
default AttachElasticLoadBalancerResponse |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
default AttachElasticLoadBalancerResponse |
attachElasticLoadBalancer(Consumer<AttachElasticLoadBalancerRequest.Builder> attachElasticLoadBalancerRequest)
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
static OpsWorksClientBuilder |
builder()
Create a builder that can be used to configure and create a
OpsWorksClient. |
default CloneStackResponse |
cloneStack(CloneStackRequest cloneStackRequest)
Creates a clone of a specified stack.
|
default CloneStackResponse |
cloneStack(Consumer<CloneStackRequest.Builder> cloneStackRequest)
Creates a clone of a specified stack.
|
static OpsWorksClient |
create()
Create a
OpsWorksClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAppResponse |
createApp(Consumer<CreateAppRequest.Builder> createAppRequest)
Creates an app for a specified stack.
|
default CreateAppResponse |
createApp(CreateAppRequest createAppRequest)
Creates an app for a specified stack.
|
default CreateDeploymentResponse |
createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
Runs deployment or stack commands.
|
default CreateDeploymentResponse |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Runs deployment or stack commands.
|
default CreateInstanceResponse |
createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest)
Creates an instance in a specified stack.
|
default CreateInstanceResponse |
createInstance(CreateInstanceRequest createInstanceRequest)
Creates an instance in a specified stack.
|
default CreateLayerResponse |
createLayer(Consumer<CreateLayerRequest.Builder> createLayerRequest)
Creates a layer.
|
default CreateLayerResponse |
createLayer(CreateLayerRequest createLayerRequest)
Creates a layer.
|
default CreateStackResponse |
createStack(Consumer<CreateStackRequest.Builder> createStackRequest)
Creates a new stack.
|
default CreateStackResponse |
createStack(CreateStackRequest createStackRequest)
Creates a new stack.
|
default CreateUserProfileResponse |
createUserProfile(Consumer<CreateUserProfileRequest.Builder> createUserProfileRequest)
Creates a new user profile.
|
default CreateUserProfileResponse |
createUserProfile(CreateUserProfileRequest createUserProfileRequest)
Creates a new user profile.
|
default DeleteAppResponse |
deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)
Deletes a specified app.
|
default DeleteAppResponse |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes a specified app.
|
default DeleteInstanceResponse |
deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
default DeleteInstanceResponse |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
default DeleteLayerResponse |
deleteLayer(Consumer<DeleteLayerRequest.Builder> deleteLayerRequest)
Deletes a specified layer.
|
default DeleteLayerResponse |
deleteLayer(DeleteLayerRequest deleteLayerRequest)
Deletes a specified layer.
|
default DeleteStackResponse |
deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest)
Deletes a specified stack.
|
default DeleteStackResponse |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
default DeleteUserProfileResponse |
deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> deleteUserProfileRequest)
Deletes a user profile.
|
default DeleteUserProfileResponse |
deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)
Deletes a user profile.
|
default DeregisterEcsClusterResponse |
deregisterEcsCluster(Consumer<DeregisterEcsClusterRequest.Builder> deregisterEcsClusterRequest)
Deregisters a specified Amazon ECS cluster from a stack.
|
default DeregisterEcsClusterResponse |
deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest)
Deregisters a specified Amazon ECS cluster from a stack.
|
default DeregisterElasticIpResponse |
deregisterElasticIp(Consumer<DeregisterElasticIpRequest.Builder> deregisterElasticIpRequest)
Deregisters a specified Elastic IP address.
|
default DeregisterElasticIpResponse |
deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest)
Deregisters a specified Elastic IP address.
|
default DeregisterInstanceResponse |
deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest)
Deregister a registered Amazon EC2 or on-premises instance.
|
default DeregisterInstanceResponse |
deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
Deregister a registered Amazon EC2 or on-premises instance.
|
default DeregisterRdsDbInstanceResponse |
deregisterRdsDbInstance(Consumer<DeregisterRdsDbInstanceRequest.Builder> deregisterRdsDbInstanceRequest)
Deregisters an Amazon RDS instance.
|
default DeregisterRdsDbInstanceResponse |
deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest)
Deregisters an Amazon RDS instance.
|
default DeregisterVolumeResponse |
deregisterVolume(Consumer<DeregisterVolumeRequest.Builder> deregisterVolumeRequest)
Deregisters an Amazon EBS volume.
|
default DeregisterVolumeResponse |
deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest)
Deregisters an Amazon EBS volume.
|
default DescribeAgentVersionsResponse |
describeAgentVersions(Consumer<DescribeAgentVersionsRequest.Builder> describeAgentVersionsRequest)
Describes the available AWS OpsWorks Stacks agent versions.
|
default DescribeAgentVersionsResponse |
describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest)
Describes the available AWS OpsWorks Stacks agent versions.
|
default DescribeAppsResponse |
describeApps(Consumer<DescribeAppsRequest.Builder> describeAppsRequest)
Requests a description of a specified set of apps.
|
default DescribeAppsResponse |
describeApps(DescribeAppsRequest describeAppsRequest)
Requests a description of a specified set of apps.
|
default DescribeCommandsResponse |
describeCommands(Consumer<DescribeCommandsRequest.Builder> describeCommandsRequest)
Describes the results of specified commands.
|
default DescribeCommandsResponse |
describeCommands(DescribeCommandsRequest describeCommandsRequest)
Describes the results of specified commands.
|
default DescribeDeploymentsResponse |
describeDeployments(Consumer<DescribeDeploymentsRequest.Builder> describeDeploymentsRequest)
Requests a description of a specified set of deployments.
|
default DescribeDeploymentsResponse |
describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest)
Requests a description of a specified set of deployments.
|
default DescribeEcsClustersResponse |
describeEcsClusters(Consumer<DescribeEcsClustersRequest.Builder> describeEcsClustersRequest)
Describes Amazon ECS clusters that are registered with a stack.
|
default DescribeEcsClustersResponse |
describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest)
Describes Amazon ECS clusters that are registered with a stack.
|
default DescribeElasticIpsResponse |
describeElasticIps(Consumer<DescribeElasticIpsRequest.Builder> describeElasticIpsRequest)
Describes Elastic IP
addresses.
|
default DescribeElasticIpsResponse |
describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest)
Describes Elastic IP
addresses.
|
default DescribeElasticLoadBalancersResponse |
describeElasticLoadBalancers(Consumer<DescribeElasticLoadBalancersRequest.Builder> describeElasticLoadBalancersRequest)
Describes a stack's Elastic Load Balancing instances.
|
default DescribeElasticLoadBalancersResponse |
describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest)
Describes a stack's Elastic Load Balancing instances.
|
default DescribeInstancesResponse |
describeInstances(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
Requests a description of a set of instances.
|
default DescribeInstancesResponse |
describeInstances(DescribeInstancesRequest describeInstancesRequest)
Requests a description of a set of instances.
|
default DescribeLayersResponse |
describeLayers(Consumer<DescribeLayersRequest.Builder> describeLayersRequest)
Requests a description of one or more layers in a specified stack.
|
default DescribeLayersResponse |
describeLayers(DescribeLayersRequest describeLayersRequest)
Requests a description of one or more layers in a specified stack.
|
default DescribeLoadBasedAutoScalingResponse |
describeLoadBasedAutoScaling(Consumer<DescribeLoadBasedAutoScalingRequest.Builder> describeLoadBasedAutoScalingRequest)
Describes load-based auto scaling configurations for specified layers.
|
default DescribeLoadBasedAutoScalingResponse |
describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)
Describes load-based auto scaling configurations for specified layers.
|
default DescribeMyUserProfileResponse |
describeMyUserProfile()
Describes a user's SSH information.
|
default DescribeMyUserProfileResponse |
describeMyUserProfile(Consumer<DescribeMyUserProfileRequest.Builder> describeMyUserProfileRequest)
Describes a user's SSH information.
|
default DescribeMyUserProfileResponse |
describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest)
Describes a user's SSH information.
|
default DescribePermissionsResponse |
describePermissions(Consumer<DescribePermissionsRequest.Builder> describePermissionsRequest)
Describes the permissions for a specified stack.
|
default DescribePermissionsResponse |
describePermissions(DescribePermissionsRequest describePermissionsRequest)
Describes the permissions for a specified stack.
|
default DescribeRaidArraysResponse |
describeRaidArrays(Consumer<DescribeRaidArraysRequest.Builder> describeRaidArraysRequest)
Describe an instance's RAID arrays.
|
default DescribeRaidArraysResponse |
describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest)
Describe an instance's RAID arrays.
|
default DescribeRdsDbInstancesResponse |
describeRdsDbInstances(Consumer<DescribeRdsDbInstancesRequest.Builder> describeRdsDbInstancesRequest)
Describes Amazon RDS instances.
|
default DescribeRdsDbInstancesResponse |
describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest)
Describes Amazon RDS instances.
|
default DescribeServiceErrorsResponse |
describeServiceErrors()
Describes AWS OpsWorks Stacks service errors.
|
default DescribeServiceErrorsResponse |
describeServiceErrors(Consumer<DescribeServiceErrorsRequest.Builder> describeServiceErrorsRequest)
Describes AWS OpsWorks Stacks service errors.
|
default DescribeServiceErrorsResponse |
describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest)
Describes AWS OpsWorks Stacks service errors.
|
default DescribeStackProvisioningParametersResponse |
describeStackProvisioningParameters(Consumer<DescribeStackProvisioningParametersRequest.Builder> describeStackProvisioningParametersRequest)
Requests a description of a stack's provisioning parameters.
|
default DescribeStackProvisioningParametersResponse |
describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest)
Requests a description of a stack's provisioning parameters.
|
default DescribeStacksResponse |
describeStacks()
Requests a description of one or more stacks.
|
default DescribeStacksResponse |
describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)
Requests a description of one or more stacks.
|
default DescribeStacksResponse |
describeStacks(DescribeStacksRequest describeStacksRequest)
Requests a description of one or more stacks.
|
default DescribeStackSummaryResponse |
describeStackSummary(Consumer<DescribeStackSummaryRequest.Builder> describeStackSummaryRequest)
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. |
default DescribeStackSummaryResponse |
describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest)
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. |
default DescribeTimeBasedAutoScalingResponse |
describeTimeBasedAutoScaling(Consumer<DescribeTimeBasedAutoScalingRequest.Builder> describeTimeBasedAutoScalingRequest)
Describes time-based auto scaling configurations for specified instances.
|
default DescribeTimeBasedAutoScalingResponse |
describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)
Describes time-based auto scaling configurations for specified instances.
|
default DescribeUserProfilesResponse |
describeUserProfiles()
Describe specified users.
|
default DescribeUserProfilesResponse |
describeUserProfiles(Consumer<DescribeUserProfilesRequest.Builder> describeUserProfilesRequest)
Describe specified users.
|
default DescribeUserProfilesResponse |
describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest)
Describe specified users.
|
default DescribeVolumesResponse |
describeVolumes(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest)
Describes an instance's Amazon EBS volumes.
|
default DescribeVolumesResponse |
describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes an instance's Amazon EBS volumes.
|
default DetachElasticLoadBalancerResponse |
detachElasticLoadBalancer(Consumer<DetachElasticLoadBalancerRequest.Builder> detachElasticLoadBalancerRequest)
Detaches a specified Elastic Load Balancing instance from its layer.
|
default DetachElasticLoadBalancerResponse |
detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)
Detaches a specified Elastic Load Balancing instance from its layer.
|
default DisassociateElasticIpResponse |
disassociateElasticIp(Consumer<DisassociateElasticIpRequest.Builder> disassociateElasticIpRequest)
Disassociates an Elastic IP address from its instance.
|
default DisassociateElasticIpResponse |
disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest)
Disassociates an Elastic IP address from its instance.
|
default GetHostnameSuggestionResponse |
getHostnameSuggestion(Consumer<GetHostnameSuggestionRequest.Builder> getHostnameSuggestionRequest)
Gets a generated host name for the specified layer, based on the current host name theme.
|
default GetHostnameSuggestionResponse |
getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest)
Gets a generated host name for the specified layer, based on the current host name theme.
|
default GrantAccessResponse |
grantAccess(Consumer<GrantAccessRequest.Builder> grantAccessRequest)
|
default GrantAccessResponse |
grantAccess(GrantAccessRequest grantAccessRequest)
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Returns a list of tags that are applied to the specified stack or layer.
|
default RebootInstanceResponse |
rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest)
Reboots a specified instance.
|
default RebootInstanceResponse |
rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Reboots a specified instance.
|
default RegisterEcsClusterResponse |
registerEcsCluster(Consumer<RegisterEcsClusterRequest.Builder> registerEcsClusterRequest)
Registers a specified Amazon ECS cluster with a stack.
|
default RegisterEcsClusterResponse |
registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest)
Registers a specified Amazon ECS cluster with a stack.
|
default RegisterElasticIpResponse |
registerElasticIp(Consumer<RegisterElasticIpRequest.Builder> registerElasticIpRequest)
Registers an Elastic IP address with a specified stack.
|
default RegisterElasticIpResponse |
registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest)
Registers an Elastic IP address with a specified stack.
|
default RegisterInstanceResponse |
registerInstance(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest)
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
|
default RegisterInstanceResponse |
registerInstance(RegisterInstanceRequest registerInstanceRequest)
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
|
default RegisterRdsDbInstanceResponse |
registerRdsDbInstance(Consumer<RegisterRdsDbInstanceRequest.Builder> registerRdsDbInstanceRequest)
Registers an Amazon RDS instance with a stack.
|
default RegisterRdsDbInstanceResponse |
registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest)
Registers an Amazon RDS instance with a stack.
|
default RegisterVolumeResponse |
registerVolume(Consumer<RegisterVolumeRequest.Builder> registerVolumeRequest)
Registers an Amazon EBS volume with a specified stack.
|
default RegisterVolumeResponse |
registerVolume(RegisterVolumeRequest registerVolumeRequest)
Registers an Amazon EBS volume with a specified stack.
|
static ServiceMetadata |
serviceMetadata() |
default SetLoadBasedAutoScalingResponse |
setLoadBasedAutoScaling(Consumer<SetLoadBasedAutoScalingRequest.Builder> setLoadBasedAutoScalingRequest)
Specify the load-based auto scaling configuration for a specified layer.
|
default SetLoadBasedAutoScalingResponse |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)
Specify the load-based auto scaling configuration for a specified layer.
|
default SetPermissionResponse |
setPermission(Consumer<SetPermissionRequest.Builder> setPermissionRequest)
Specifies a user's permissions.
|
default SetPermissionResponse |
setPermission(SetPermissionRequest setPermissionRequest)
Specifies a user's permissions.
|
default SetTimeBasedAutoScalingResponse |
setTimeBasedAutoScaling(Consumer<SetTimeBasedAutoScalingRequest.Builder> setTimeBasedAutoScalingRequest)
Specify the time-based auto scaling configuration for a specified instance.
|
default SetTimeBasedAutoScalingResponse |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest)
Specify the time-based auto scaling configuration for a specified instance.
|
default StartInstanceResponse |
startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest)
Starts a specified instance.
|
default StartInstanceResponse |
startInstance(StartInstanceRequest startInstanceRequest)
Starts a specified instance.
|
default StartStackResponse |
startStack(Consumer<StartStackRequest.Builder> startStackRequest)
Starts a stack's instances.
|
default StartStackResponse |
startStack(StartStackRequest startStackRequest)
Starts a stack's instances.
|
default StopInstanceResponse |
stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest)
Stops a specified instance.
|
default StopInstanceResponse |
stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specified instance.
|
default StopStackResponse |
stopStack(Consumer<StopStackRequest.Builder> stopStackRequest)
Stops a specified stack.
|
default StopStackResponse |
stopStack(StopStackRequest stopStackRequest)
Stops a specified stack.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
|
default UnassignInstanceResponse |
unassignInstance(Consumer<UnassignInstanceRequest.Builder> unassignInstanceRequest)
Unassigns a registered instance from all of it's layers.
|
default UnassignInstanceResponse |
unassignInstance(UnassignInstanceRequest unassignInstanceRequest)
Unassigns a registered instance from all of it's layers.
|
default UnassignVolumeResponse |
unassignVolume(Consumer<UnassignVolumeRequest.Builder> unassignVolumeRequest)
Unassigns an assigned Amazon EBS volume.
|
default UnassignVolumeResponse |
unassignVolume(UnassignVolumeRequest unassignVolumeRequest)
Unassigns an assigned Amazon EBS volume.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a specified stack or layer.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a specified stack or layer.
|
default UpdateAppResponse |
updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)
Updates a specified app.
|
default UpdateAppResponse |
updateApp(UpdateAppRequest updateAppRequest)
Updates a specified app.
|
default UpdateElasticIpResponse |
updateElasticIp(Consumer<UpdateElasticIpRequest.Builder> updateElasticIpRequest)
Updates a registered Elastic IP address's name.
|
default UpdateElasticIpResponse |
updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest)
Updates a registered Elastic IP address's name.
|
default UpdateInstanceResponse |
updateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest)
Updates a specified instance.
|
default UpdateInstanceResponse |
updateInstance(UpdateInstanceRequest updateInstanceRequest)
Updates a specified instance.
|
default UpdateLayerResponse |
updateLayer(Consumer<UpdateLayerRequest.Builder> updateLayerRequest)
Updates a specified layer.
|
default UpdateLayerResponse |
updateLayer(UpdateLayerRequest updateLayerRequest)
Updates a specified layer.
|
default UpdateMyUserProfileResponse |
updateMyUserProfile(Consumer<UpdateMyUserProfileRequest.Builder> updateMyUserProfileRequest)
Updates a user's SSH public key.
|
default UpdateMyUserProfileResponse |
updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest)
Updates a user's SSH public key.
|
default UpdateRdsDbInstanceResponse |
updateRdsDbInstance(Consumer<UpdateRdsDbInstanceRequest.Builder> updateRdsDbInstanceRequest)
Updates an Amazon RDS instance.
|
default UpdateRdsDbInstanceResponse |
updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest)
Updates an Amazon RDS instance.
|
default UpdateStackResponse |
updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest)
Updates a specified stack.
|
default UpdateStackResponse |
updateStack(UpdateStackRequest updateStackRequest)
Updates a specified stack.
|
default UpdateUserProfileResponse |
updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest)
Updates a specified user profile.
|
default UpdateUserProfileResponse |
updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)
Updates a specified user profile.
|
default UpdateVolumeResponse |
updateVolume(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest)
Updates an Amazon EBS volume's name or mount point.
|
default UpdateVolumeResponse |
updateVolume(UpdateVolumeRequest updateVolumeRequest)
Updates an Amazon EBS volume's name or mount point.
|
serviceNameclosestatic final String SERVICE_NAME
static OpsWorksClient create()
OpsWorksClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OpsWorksClientBuilder builder()
OpsWorksClient.default AssignInstanceResponse assignInstance(AssignInstanceRequest assignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS 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.
assignInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssignInstanceResponse assignInstance(Consumer<AssignInstanceRequest.Builder> assignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 AWS OpsWorks Stacks.
Required Permissions: To use this action, an AWS 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.
This is a convenience which creates an instance of the AssignInstanceRequest.Builder avoiding the need to
create one manually via AssignInstanceRequest.builder()
assignInstanceRequest - A Consumer that will call methods on AssignInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssignVolumeResponse assignVolume(AssignVolumeRequest assignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
assignVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssignVolumeResponse assignVolume(Consumer<AssignVolumeRequest.Builder> assignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the AssignVolumeRequest.Builder avoiding the need to
create one manually via AssignVolumeRequest.builder()
assignVolumeRequest - A Consumer that will call methods on AssignVolumeRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateElasticIpResponse associateElasticIp(AssociateElasticIpRequest associateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
associateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateElasticIpResponse associateElasticIp(Consumer<AssociateElasticIpRequest.Builder> associateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the AssociateElasticIpRequest.Builder avoiding the
need to create one manually via AssociateElasticIpRequest.builder()
associateElasticIpRequest - A Consumer that will call methods on AssociateElasticIpRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachElasticLoadBalancerResponse attachElasticLoadBalancer(AttachElasticLoadBalancerRequest attachElasticLoadBalancerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
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.
attachElasticLoadBalancerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachElasticLoadBalancerResponse attachElasticLoadBalancer(Consumer<AttachElasticLoadBalancerRequest.Builder> attachElasticLoadBalancerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
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.
This is a convenience which creates an instance of the AttachElasticLoadBalancerRequest.Builder avoiding
the need to create one manually via AttachElasticLoadBalancerRequest.builder()
attachElasticLoadBalancerRequest - A Consumer that will call methods on AttachElasticLoadBalancerRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CloneStackResponse cloneStack(CloneStackRequest cloneStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
cloneStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CloneStackResponse cloneStack(Consumer<CloneStackRequest.Builder> cloneStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the CloneStackRequest.Builder avoiding the need to
create one manually via CloneStackRequest.builder()
cloneStackRequest - A Consumer that will call methods on CloneStackRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAppResponse createApp(CreateAppRequest createAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
createAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAppResponse createApp(Consumer<CreateAppRequest.Builder> createAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the CreateAppRequest.Builder avoiding the need to
create one manually via CreateAppRequest.builder()
createAppRequest - A Consumer that will call methods on CreateAppRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
createDeploymentRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the CreateDeploymentRequest.Builder avoiding the need
to create one manually via CreateDeploymentRequest.builder()
createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstanceResponse createInstance(CreateInstanceRequest createInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
createInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstanceResponse createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the CreateInstanceRequest.Builder avoiding the need to
create one manually via CreateInstanceRequest.builder()
createInstanceRequest - A Consumer that will call methods on CreateInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLayerResponse createLayer(CreateLayerRequest createLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
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.
createLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLayerResponse createLayer(Consumer<CreateLayerRequest.Builder> createLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
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.
This is a convenience which creates an instance of the CreateLayerRequest.Builder avoiding the need to
create one manually via CreateLayerRequest.builder()
createLayerRequest - A Consumer that will call methods on CreateLayerRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackResponse createStack(CreateStackRequest createStackRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
createStackRequest - ValidationException - Indicates that a request was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackResponse createStack(Consumer<CreateStackRequest.Builder> createStackRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the CreateStackRequest.Builder avoiding the need to
create one manually via CreateStackRequest.builder()
createStackRequest - A Consumer that will call methods on CreateStackRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserProfileResponse createUserProfile(CreateUserProfileRequest createUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
createUserProfileRequest - ValidationException - Indicates that a request was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserProfileResponse createUserProfile(Consumer<CreateUserProfileRequest.Builder> createUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the CreateUserProfileRequest.Builder avoiding the need
to create one manually via CreateUserProfileRequest.builder()
createUserProfileRequest - A Consumer that will call methods on CreateUserProfileRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
deleteAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DeleteAppRequest.Builder avoiding the need to
create one manually via DeleteAppRequest.builder()
deleteAppRequest - A Consumer that will call methods on DeleteAppRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
deleteInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DeleteInstanceRequest.Builder avoiding the need to
create one manually via DeleteInstanceRequest.builder()
deleteInstanceRequest - A Consumer that will call methods on DeleteInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLayerResponse deleteLayer(DeleteLayerRequest deleteLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
deleteLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLayerResponse deleteLayer(Consumer<DeleteLayerRequest.Builder> deleteLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DeleteLayerRequest.Builder avoiding the need to
create one manually via DeleteLayerRequest.builder()
deleteLayerRequest - A Consumer that will call methods on DeleteLayerRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
deleteStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackResponse deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DeleteStackRequest.Builder avoiding the need to
create one manually via DeleteStackRequest.builder()
deleteStackRequest - A Consumer that will call methods on DeleteStackRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserProfileResponse deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
deleteUserProfileRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserProfileResponse deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> deleteUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DeleteUserProfileRequest.Builder avoiding the need
to create one manually via DeleteUserProfileRequest.builder()
deleteUserProfileRequest - A Consumer that will call methods on DeleteUserProfileRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterEcsClusterResponse deregisterEcsCluster(DeregisterEcsClusterRequest deregisterEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsClusterRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterEcsClusterResponse deregisterEcsCluster(Consumer<DeregisterEcsClusterRequest.Builder> deregisterEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
This is a convenience which creates an instance of the DeregisterEcsClusterRequest.Builder avoiding the
need to create one manually via DeregisterEcsClusterRequest.builder()
deregisterEcsClusterRequest - A Consumer that will call methods on DeregisterEcsClusterRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterElasticIpResponse deregisterElasticIp(DeregisterElasticIpRequest deregisterElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Deregisters a specified Elastic IP address. The address 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.
deregisterElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterElasticIpResponse deregisterElasticIp(Consumer<DeregisterElasticIpRequest.Builder> deregisterElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Deregisters a specified Elastic IP address. The address 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.
This is a convenience which creates an instance of the DeregisterElasticIpRequest.Builder avoiding the
need to create one manually via DeregisterElasticIpRequest.builder()
deregisterElasticIpRequest - A Consumer that will call methods on DeregisterElasticIpRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterInstanceResponse deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS 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 on user permissions, see Managing User Permissions.
deregisterInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterInstanceResponse deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS 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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DeregisterInstanceRequest.Builder avoiding the
need to create one manually via DeregisterInstanceRequest.builder()
deregisterInstanceRequest - A Consumer that will call methods on DeregisterInstanceRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterRdsDbInstanceResponse deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest deregisterRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
deregisterRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterRdsDbInstanceResponse deregisterRdsDbInstance(Consumer<DeregisterRdsDbInstanceRequest.Builder> deregisterRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DeregisterRdsDbInstanceRequest.Builder avoiding
the need to create one manually via DeregisterRdsDbInstanceRequest.builder()
deregisterRdsDbInstanceRequest - A Consumer that will call methods on DeregisterRdsDbInstanceRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterVolumeResponse deregisterVolume(DeregisterVolumeRequest deregisterVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
deregisterVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterVolumeResponse deregisterVolume(Consumer<DeregisterVolumeRequest.Builder> deregisterVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DeregisterVolumeRequest.Builder avoiding the need
to create one manually via DeregisterVolumeRequest.builder()
deregisterVolumeRequest - A Consumer that will call methods on DeregisterVolumeRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAgentVersionsResponse describeAgentVersions(DescribeAgentVersionsRequest describeAgentVersionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes the available AWS 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.
describeAgentVersionsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAgentVersionsResponse describeAgentVersions(Consumer<DescribeAgentVersionsRequest.Builder> describeAgentVersionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes the available AWS 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.
This is a convenience which creates an instance of the DescribeAgentVersionsRequest.Builder avoiding the
need to create one manually via DescribeAgentVersionsRequest.builder()
describeAgentVersionsRequest - A Consumer that will call methods on DescribeAgentVersionsRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAppsResponse describeApps(DescribeAppsRequest describeAppsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeAppsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAppsResponse describeApps(Consumer<DescribeAppsRequest.Builder> describeAppsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeAppsRequest.Builder avoiding the need to
create one manually via DescribeAppsRequest.builder()
describeAppsRequest - A Consumer that will call methods on DescribeAppsRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCommandsResponse describeCommands(DescribeCommandsRequest describeCommandsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeCommandsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCommandsResponse describeCommands(Consumer<DescribeCommandsRequest.Builder> describeCommandsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeCommandsRequest.Builder avoiding the need
to create one manually via DescribeCommandsRequest.builder()
describeCommandsRequest - A Consumer that will call methods on DescribeCommandsRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDeploymentsResponse describeDeployments(DescribeDeploymentsRequest describeDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeDeploymentsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDeploymentsResponse describeDeployments(Consumer<DescribeDeploymentsRequest.Builder> describeDeploymentsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeDeploymentsRequest.Builder avoiding the
need to create one manually via DescribeDeploymentsRequest.builder()
describeDeploymentsRequest - A Consumer that will call methods on DescribeDeploymentsRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEcsClustersResponse describeEcsClusters(DescribeEcsClustersRequest describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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, AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClustersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEcsClustersResponse describeEcsClusters(Consumer<DescribeEcsClustersRequest.Builder> describeEcsClustersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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, AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a convenience which creates an instance of the DescribeEcsClustersRequest.Builder avoiding the
need to create one manually via DescribeEcsClustersRequest.builder()
describeEcsClustersRequest - A Consumer that will call methods on DescribeEcsClustersRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticIpsResponse describeElasticIps(DescribeElasticIpsRequest describeElasticIpsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeElasticIpsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticIpsResponse describeElasticIps(Consumer<DescribeElasticIpsRequest.Builder> describeElasticIpsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeElasticIpsRequest.Builder avoiding the
need to create one manually via DescribeElasticIpsRequest.builder()
describeElasticIpsRequest - A Consumer that will call methods on DescribeElasticIpsRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticLoadBalancersResponse describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest describeElasticLoadBalancersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeElasticLoadBalancersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticLoadBalancersResponse describeElasticLoadBalancers(Consumer<DescribeElasticLoadBalancersRequest.Builder> describeElasticLoadBalancersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeElasticLoadBalancersRequest.Builder
avoiding the need to create one manually via DescribeElasticLoadBalancersRequest.builder()
describeElasticLoadBalancersRequest - A Consumer that will call methods on DescribeElasticLoadBalancersRequest.Builder to create
a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeInstancesResponse describeInstances(DescribeInstancesRequest describeInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeInstancesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeInstancesResponse describeInstances(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeInstancesRequest.Builder avoiding the need
to create one manually via DescribeInstancesRequest.builder()
describeInstancesRequest - A Consumer that will call methods on DescribeInstancesRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLayersResponse describeLayers(DescribeLayersRequest describeLayersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeLayersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLayersResponse describeLayers(Consumer<DescribeLayersRequest.Builder> describeLayersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeLayersRequest.Builder avoiding the need to
create one manually via DescribeLayersRequest.builder()
describeLayersRequest - A Consumer that will call methods on DescribeLayersRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLoadBasedAutoScalingResponse describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the 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 on user permissions, see Managing User Permissions.
describeLoadBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLoadBasedAutoScalingResponse describeLoadBasedAutoScaling(Consumer<DescribeLoadBasedAutoScalingRequest.Builder> describeLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the 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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeLoadBasedAutoScalingRequest.Builder
avoiding the need to create one manually via DescribeLoadBasedAutoScalingRequest.builder()
describeLoadBasedAutoScalingRequest - A Consumer that will call methods on DescribeLoadBasedAutoScalingRequest.Builder to create
a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMyUserProfileResponse describeMyUserProfile() throws AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeMyUserProfile(DescribeMyUserProfileRequest),
AWS
API Documentationdefault DescribeMyUserProfileResponse describeMyUserProfile(DescribeMyUserProfileRequest describeMyUserProfileRequest) throws AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
describeMyUserProfileRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMyUserProfileResponse describeMyUserProfile(Consumer<DescribeMyUserProfileRequest.Builder> describeMyUserProfileRequest) throws AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeMyUserProfileRequest.Builder avoiding the
need to create one manually via DescribeMyUserProfileRequest.builder()
describeMyUserProfileRequest - A Consumer that will call methods on DescribeMyUserProfileRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePermissionsResponse describePermissions(DescribePermissionsRequest describePermissionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
describePermissionsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePermissionsResponse describePermissions(Consumer<DescribePermissionsRequest.Builder> describePermissionsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DescribePermissionsRequest.Builder avoiding the
need to create one manually via DescribePermissionsRequest.builder()
describePermissionsRequest - A Consumer that will call methods on DescribePermissionsRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRaidArraysResponse describeRaidArrays(DescribeRaidArraysRequest describeRaidArraysRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeRaidArraysRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRaidArraysResponse describeRaidArrays(Consumer<DescribeRaidArraysRequest.Builder> describeRaidArraysRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeRaidArraysRequest.Builder avoiding the
need to create one manually via DescribeRaidArraysRequest.builder()
describeRaidArraysRequest - A Consumer that will call methods on DescribeRaidArraysRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRdsDbInstancesResponse describeRdsDbInstances(DescribeRdsDbInstancesRequest describeRdsDbInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeRdsDbInstancesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRdsDbInstancesResponse describeRdsDbInstances(Consumer<DescribeRdsDbInstancesRequest.Builder> describeRdsDbInstancesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a convenience which creates an instance of the DescribeRdsDbInstancesRequest.Builder avoiding the
need to create one manually via DescribeRdsDbInstancesRequest.builder()
describeRdsDbInstancesRequest - A Consumer that will call methods on DescribeRdsDbInstancesRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServiceErrorsResponse describeServiceErrors() throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeServiceErrors(DescribeServiceErrorsRequest),
AWS
API Documentationdefault DescribeServiceErrorsResponse describeServiceErrors(DescribeServiceErrorsRequest describeServiceErrorsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrorsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServiceErrorsResponse describeServiceErrors(Consumer<DescribeServiceErrorsRequest.Builder> describeServiceErrorsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes AWS 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 on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This is a convenience which creates an instance of the DescribeServiceErrorsRequest.Builder avoiding the
need to create one manually via DescribeServiceErrorsRequest.builder()
describeServiceErrorsRequest - A Consumer that will call methods on DescribeServiceErrorsRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackProvisioningParametersResponse describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest describeStackProvisioningParametersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
describeStackProvisioningParametersRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackProvisioningParametersResponse describeStackProvisioningParameters(Consumer<DescribeStackProvisioningParametersRequest.Builder> describeStackProvisioningParametersRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeStackProvisioningParametersRequest.Builder
avoiding the need to create one manually via DescribeStackProvisioningParametersRequest.builder()
describeStackProvisioningParametersRequest - A Consumer that will call methods on DescribeStackProvisioningParametersRequest.Builder to
create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackSummaryResponse describeStackSummary(DescribeStackSummaryRequest describeStackSummaryRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
describeStackSummaryRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackSummaryResponse describeStackSummary(Consumer<DescribeStackSummaryRequest.Builder> describeStackSummaryRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeStackSummaryRequest.Builder avoiding the
need to create one manually via DescribeStackSummaryRequest.builder()
describeStackSummaryRequest - A Consumer that will call methods on DescribeStackSummaryRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksResponse describeStacks() throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeStacks(DescribeStacksRequest),
AWS API
Documentationdefault DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
describeStacksRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksResponse describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeStacksRequest.Builder avoiding the need to
create one manually via DescribeStacksRequest.builder()
describeStacksRequest - A Consumer that will call methods on DescribeStacksRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTimeBasedAutoScalingResponse describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the 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 on user permissions, see Managing User Permissions.
describeTimeBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTimeBasedAutoScalingResponse describeTimeBasedAutoScaling(Consumer<DescribeTimeBasedAutoScalingRequest.Builder> describeTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the 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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeTimeBasedAutoScalingRequest.Builder
avoiding the need to create one manually via DescribeTimeBasedAutoScalingRequest.builder()
describeTimeBasedAutoScalingRequest - A Consumer that will call methods on DescribeTimeBasedAutoScalingRequest.Builder to create
a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserProfilesResponse describeUserProfiles() throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeUserProfiles(DescribeUserProfilesRequest),
AWS
API Documentationdefault DescribeUserProfilesResponse describeUserProfiles(DescribeUserProfilesRequest describeUserProfilesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
describeUserProfilesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserProfilesResponse describeUserProfiles(Consumer<DescribeUserProfilesRequest.Builder> describeUserProfilesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeUserProfilesRequest.Builder avoiding the
need to create one manually via DescribeUserProfilesRequest.builder()
describeUserProfilesRequest - A Consumer that will call methods on DescribeUserProfilesRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVolumesResponse describeVolumes(DescribeVolumesRequest describeVolumesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
describeVolumesRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVolumesResponse describeVolumes(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the DescribeVolumesRequest.Builder avoiding the need
to create one manually via DescribeVolumesRequest.builder()
describeVolumesRequest - A Consumer that will call methods on DescribeVolumesRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachElasticLoadBalancerResponse detachElasticLoadBalancer(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
detachElasticLoadBalancerRequest - ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachElasticLoadBalancerResponse detachElasticLoadBalancer(Consumer<DetachElasticLoadBalancerRequest.Builder> detachElasticLoadBalancerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DetachElasticLoadBalancerRequest.Builder avoiding
the need to create one manually via DetachElasticLoadBalancerRequest.builder()
detachElasticLoadBalancerRequest - A Consumer that will call methods on DetachElasticLoadBalancerRequest.Builder to create a
request.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateElasticIpResponse disassociateElasticIp(DisassociateElasticIpRequest disassociateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
disassociateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateElasticIpResponse disassociateElasticIp(Consumer<DisassociateElasticIpRequest.Builder> disassociateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the DisassociateElasticIpRequest.Builder avoiding the
need to create one manually via DisassociateElasticIpRequest.builder()
disassociateElasticIpRequest - A Consumer that will call methods on DisassociateElasticIpRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetHostnameSuggestionResponse getHostnameSuggestion(GetHostnameSuggestionRequest getHostnameSuggestionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
getHostnameSuggestionRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetHostnameSuggestionResponse getHostnameSuggestion(Consumer<GetHostnameSuggestionRequest.Builder> getHostnameSuggestionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the GetHostnameSuggestionRequest.Builder avoiding the
need to create one manually via GetHostnameSuggestionRequest.builder()
getHostnameSuggestionRequest - A Consumer that will call methods on GetHostnameSuggestionRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GrantAccessResponse grantAccess(GrantAccessRequest grantAccessRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccessRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GrantAccessResponse grantAccess(Consumer<GrantAccessRequest.Builder> grantAccessRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
This is a convenience which creates an instance of the GrantAccessRequest.Builder avoiding the need to
create one manually via GrantAccessRequest.builder()
grantAccessRequest - A Consumer that will call methods on GrantAccessRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Returns a list of tags that are applied to the specified stack or layer.
listTagsRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Returns a list of tags that are applied to the specified stack or layer.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
rebootInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootInstanceResponse rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the RebootInstanceRequest.Builder avoiding the need to
create one manually via RebootInstanceRequest.builder()
rebootInstanceRequest - A Consumer that will call methods on RebootInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterEcsClusterResponse registerEcsCluster(RegisterEcsClusterRequest registerEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
registerEcsClusterRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterEcsClusterResponse registerEcsCluster(Consumer<RegisterEcsClusterRequest.Builder> registerEcsClusterRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the RegisterEcsClusterRequest.Builder avoiding the
need to create one manually via RegisterEcsClusterRequest.builder()
registerEcsClusterRequest - A Consumer that will call methods on RegisterEcsClusterRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterElasticIpResponse registerElasticIp(RegisterElasticIpRequest registerElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
registerElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterElasticIpResponse registerElasticIp(Consumer<RegisterElasticIpRequest.Builder> registerElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the RegisterElasticIpRequest.Builder avoiding the need
to create one manually via RegisterElasticIpRequest.builder()
registerElasticIpRequest - A Consumer that will call methods on RegisterElasticIpRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterInstanceResponse registerInstance(RegisterInstanceRequest registerInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance handles only the second step. You should instead use the AWS CLI
register command, which performs the entire registration operation. For more information, see Registering an
Instance with an AWS OpsWorks Stacks 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.
registerInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterInstanceResponse registerInstance(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance handles only the second step. You should instead use the AWS CLI
register command, which performs the entire registration operation. For more information, see Registering an
Instance with an AWS OpsWorks Stacks 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.
This is a convenience which creates an instance of the RegisterInstanceRequest.Builder avoiding the need
to create one manually via RegisterInstanceRequest.builder()
registerInstanceRequest - A Consumer that will call methods on RegisterInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterRdsDbInstanceResponse registerRdsDbInstance(RegisterRdsDbInstanceRequest registerRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
registerRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterRdsDbInstanceResponse registerRdsDbInstance(Consumer<RegisterRdsDbInstanceRequest.Builder> registerRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the RegisterRdsDbInstanceRequest.Builder avoiding the
need to create one manually via RegisterRdsDbInstanceRequest.builder()
registerRdsDbInstanceRequest - A Consumer that will call methods on RegisterRdsDbInstanceRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterVolumeResponse registerVolume(RegisterVolumeRequest registerVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
registerVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterVolumeResponse registerVolume(Consumer<RegisterVolumeRequest.Builder> registerVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the RegisterVolumeRequest.Builder avoiding the need to
create one manually via RegisterVolumeRequest.builder()
registerVolumeRequest - A Consumer that will call methods on RegisterVolumeRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetLoadBasedAutoScalingResponse setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
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.
setLoadBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetLoadBasedAutoScalingResponse setLoadBasedAutoScaling(Consumer<SetLoadBasedAutoScalingRequest.Builder> setLoadBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
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.
This is a convenience which creates an instance of the SetLoadBasedAutoScalingRequest.Builder avoiding
the need to create one manually via SetLoadBasedAutoScalingRequest.builder()
setLoadBasedAutoScalingRequest - A Consumer that will call methods on SetLoadBasedAutoScalingRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetPermissionResponse setPermission(SetPermissionRequest setPermissionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
setPermissionRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetPermissionResponse setPermission(Consumer<SetPermissionRequest.Builder> setPermissionRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the SetPermissionRequest.Builder avoiding the need to
create one manually via SetPermissionRequest.builder()
setPermissionRequest - A Consumer that will call methods on SetPermissionRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetTimeBasedAutoScalingResponse setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest setTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
setTimeBasedAutoScalingRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetTimeBasedAutoScalingResponse setTimeBasedAutoScaling(Consumer<SetTimeBasedAutoScalingRequest.Builder> setTimeBasedAutoScalingRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the SetTimeBasedAutoScalingRequest.Builder avoiding
the need to create one manually via SetTimeBasedAutoScalingRequest.builder()
setTimeBasedAutoScalingRequest - A Consumer that will call methods on SetTimeBasedAutoScalingRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
startInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartInstanceResponse startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the StartInstanceRequest.Builder avoiding the need to
create one manually via StartInstanceRequest.builder()
startInstanceRequest - A Consumer that will call methods on StartInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartStackResponse startStack(StartStackRequest startStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
startStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartStackResponse startStack(Consumer<StartStackRequest.Builder> startStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the StartStackRequest.Builder avoiding the need to
create one manually via StartStackRequest.builder()
startStackRequest - A Consumer that will call methods on StartStackRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
stopInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopInstanceResponse stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the StopInstanceRequest.Builder avoiding the need to
create one manually via StopInstanceRequest.builder()
stopInstanceRequest - A Consumer that will call methods on StopInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopStackResponse stopStack(StopStackRequest stopStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
stopStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopStackResponse stopStack(Consumer<StopStackRequest.Builder> stopStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the StopStackRequest.Builder avoiding the need to
create one manually via StopStackRequest.builder()
stopStackRequest - A Consumer that will call methods on StopStackRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
tagResourceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnassignInstanceResponse unassignInstance(UnassignInstanceRequest unassignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Unassigns a registered instance from all of it's layers. 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 AWS 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 on user permissions, see Managing User Permissions.
unassignInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnassignInstanceResponse unassignInstance(Consumer<UnassignInstanceRequest.Builder> unassignInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Unassigns a registered instance from all of it's layers. 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 AWS 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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the UnassignInstanceRequest.Builder avoiding the need
to create one manually via UnassignInstanceRequest.builder()
unassignInstanceRequest - A Consumer that will call methods on UnassignInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnassignVolumeResponse unassignVolume(UnassignVolumeRequest unassignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
unassignVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnassignVolumeResponse unassignVolume(Consumer<UnassignVolumeRequest.Builder> unassignVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UnassignVolumeRequest.Builder avoiding the need to
create one manually via UnassignVolumeRequest.builder()
unassignVolumeRequest - A Consumer that will call methods on UnassignVolumeRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Removes tags from a specified stack or layer.
untagResourceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
Removes tags from a specified stack or layer.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateAppRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAppResponse updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateAppRequest.Builder avoiding the need to
create one manually via UpdateAppRequest.builder()
updateAppRequest - A Consumer that will call methods on UpdateAppRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateElasticIpResponse updateElasticIp(UpdateElasticIpRequest updateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateElasticIpRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateElasticIpResponse updateElasticIp(Consumer<UpdateElasticIpRequest.Builder> updateElasticIpRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateElasticIpRequest.Builder avoiding the need
to create one manually via UpdateElasticIpRequest.builder()
updateElasticIpRequest - A Consumer that will call methods on UpdateElasticIpRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateInstanceResponse updateInstance(UpdateInstanceRequest updateInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateInstanceResponse updateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateInstanceRequest.Builder avoiding the need to
create one manually via UpdateInstanceRequest.builder()
updateInstanceRequest - A Consumer that will call methods on UpdateInstanceRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLayerResponse updateLayer(UpdateLayerRequest updateLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateLayerRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLayerResponse updateLayer(Consumer<UpdateLayerRequest.Builder> updateLayerRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateLayerRequest.Builder avoiding the need to
create one manually via UpdateLayerRequest.builder()
updateLayerRequest - A Consumer that will call methods on UpdateLayerRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMyUserProfileResponse updateMyUserProfile(UpdateMyUserProfileRequest updateMyUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
updateMyUserProfileRequest - ValidationException - Indicates that a request was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMyUserProfileResponse updateMyUserProfile(Consumer<UpdateMyUserProfileRequest.Builder> updateMyUserProfileRequest) throws ValidationException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the UpdateMyUserProfileRequest.Builder avoiding the
need to create one manually via UpdateMyUserProfileRequest.builder()
updateMyUserProfileRequest - A Consumer that will call methods on UpdateMyUserProfileRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRdsDbInstanceResponse updateRdsDbInstance(UpdateRdsDbInstanceRequest updateRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateRdsDbInstanceRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRdsDbInstanceResponse updateRdsDbInstance(Consumer<UpdateRdsDbInstanceRequest.Builder> updateRdsDbInstanceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateRdsDbInstanceRequest.Builder avoiding the
need to create one manually via UpdateRdsDbInstanceRequest.builder()
updateRdsDbInstanceRequest - A Consumer that will call methods on UpdateRdsDbInstanceRequest.Builder to create a
request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateStackRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackResponse updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateStackRequest.Builder avoiding the need to
create one manually via UpdateStackRequest.builder()
updateStackRequest - A Consumer that will call methods on UpdateStackRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserProfileResponse updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
updateUserProfileRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserProfileResponse updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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 on user permissions, see Managing User Permissions.
This is a convenience which creates an instance of the UpdateUserProfileRequest.Builder avoiding the need
to create one manually via UpdateUserProfileRequest.builder()
updateUserProfileRequest - A Consumer that will call methods on UpdateUserProfileRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateVolumeResponse updateVolume(UpdateVolumeRequest updateVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
updateVolumeRequest - ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateVolumeResponse updateVolume(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OpsWorksException
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.
This is a convenience which creates an instance of the UpdateVolumeRequest.Builder avoiding the need to
create one manually via UpdateVolumeRequest.builder()
updateVolumeRequest - A Consumer that will call methods on UpdateVolumeRequest.Builder to create a request.ValidationException - Indicates that a request was not valid.ResourceNotFoundException - Indicates that a resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpsWorksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.