Package com.amazonaws.services.opsworks

Class AWSOpsWorksClient

  • All Implemented Interfaces:
    AWSOpsWorks
    Direct Known Subclasses:
    AWSOpsWorksAsyncClient
    @ThreadSafe
public class AWSOpsWorksClient
extends AmazonWebServiceClient
implements AWSOpsWorks
    Client for accessing AWS OpsWorks. All service calls made using this client are blocking, and will not return until the service call completes.

    AWS OpsWorks

    Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

    AWS OpsWorks 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 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 supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

    Chef Versions

    When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended value for Linux stacks is currently 12 (the default is 11.4). 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.

    • Field Detail

      • configFactory

        protected static final ClientConfigurationFactory configFactory
        Client configuration factory providing ClientConfigurations tailored to this client

    • Constructor Detail

      • AWSOpsWorksClient

        public AWSOpsWorksClient()
        Constructs a new client to invoke service methods on AWS OpsWorks. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain

      • AWSOpsWorksClient

        public AWSOpsWorksClient​(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS OpsWorks. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain

      • AWSOpsWorksClient

        public AWSOpsWorksClient​(AWSCredentials awsCredentials)
        Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

      • AWSOpsWorksClient

        public AWSOpsWorksClient​(AWSCredentials awsCredentials,
                         ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).

      • AWSOpsWorksClient

        public AWSOpsWorksClient​(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

      • AWSOpsWorksClient

        public AWSOpsWorksClient​(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).

      • AWSOpsWorksClient

        public AWSOpsWorksClient​(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration,
                         RequestMetricCollector requestMetricCollector)
        Constructs a new client to invoke service methods on AWS OpsWorks using the specified AWS account credentials provider, client configuration options, and request metric collector.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS OpsWorks (ex: proxy settings, retry counts, etc.).
        requestMetricCollector - optional request metric collector

    • Method Detail

      • assignInstance

        public AssignInstanceResult assignInstance​(AssignInstanceRequest assignInstanceRequest)

        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.

        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.

        Specified by:
        assignInstance in interface AWSOpsWorks
        Parameters:
        assignInstanceRequest -
        Returns:
        Result of the AssignInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • assignVolume

        public AssignVolumeResult assignVolume​(AssignVolumeRequest assignVolumeRequest)

        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.

        Specified by:
        assignVolume in interface AWSOpsWorks
        Parameters:
        assignVolumeRequest -
        Returns:
        Result of the AssignVolume operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • cloneStack

        public CloneStackResult cloneStack​(CloneStackRequest cloneStackRequest)

        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.

        Specified by:
        cloneStack in interface AWSOpsWorks
        Parameters:
        cloneStackRequest -
        Returns:
        Result of the CloneStack operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • createApp

        public CreateAppResult createApp​(CreateAppRequest createAppRequest)

        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.

        Specified by:
        createApp in interface AWSOpsWorks
        Parameters:
        createAppRequest -
        Returns:
        Result of the CreateApp operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • createLayer

        public CreateLayerResult createLayer​(CreateLayerRequest createLayerRequest)

        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.

        Specified by:
        createLayer in interface AWSOpsWorks
        Parameters:
        createLayerRequest -
        Returns:
        Result of the CreateLayer operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • deleteApp

        public DeleteAppResult deleteApp​(DeleteAppRequest deleteAppRequest)

        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.

        Specified by:
        deleteApp in interface AWSOpsWorks
        Parameters:
        deleteAppRequest -
        Returns:
        Result of the DeleteApp operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • deleteInstance

        public DeleteInstanceResult deleteInstance​(DeleteInstanceRequest deleteInstanceRequest)

        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.

        Specified by:
        deleteInstance in interface AWSOpsWorks
        Parameters:
        deleteInstanceRequest -
        Returns:
        Result of the DeleteInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • deleteLayer

        public DeleteLayerResult deleteLayer​(DeleteLayerRequest deleteLayerRequest)

        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.

        Specified by:
        deleteLayer in interface AWSOpsWorks
        Parameters:
        deleteLayerRequest -
        Returns:
        Result of the DeleteLayer operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • deleteStack

        public DeleteStackResult deleteStack​(DeleteStackRequest deleteStackRequest)

        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.

        Specified by:
        deleteStack in interface AWSOpsWorks
        Parameters:
        deleteStackRequest -
        Returns:
        Result of the DeleteStack operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • deregisterInstance

        public DeregisterInstanceResult deregisterInstance​(DeregisterInstanceRequest deregisterInstanceRequest)

        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.

        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.

        Specified by:
        deregisterInstance in interface AWSOpsWorks
        Parameters:
        deregisterInstanceRequest -
        Returns:
        Result of the DeregisterInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeAgentVersions

        public DescribeAgentVersionsResult describeAgentVersions​(DescribeAgentVersionsRequest describeAgentVersionsRequest)

        Describes the available AWS OpsWorks 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.

        Specified by:
        describeAgentVersions in interface AWSOpsWorks
        Parameters:
        describeAgentVersionsRequest -
        Returns:
        Result of the DescribeAgentVersions operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeApps

        public DescribeAppsResult describeApps​(DescribeAppsRequest describeAppsRequest)

        Requests a description of a specified set of apps.

        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.

        Specified by:
        describeApps in interface AWSOpsWorks
        Parameters:
        describeAppsRequest -
        Returns:
        Result of the DescribeApps operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeCommands

        public DescribeCommandsResult describeCommands​(DescribeCommandsRequest describeCommandsRequest)

        Describes the results of specified commands.

        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.

        Specified by:
        describeCommands in interface AWSOpsWorks
        Parameters:
        describeCommandsRequest -
        Returns:
        Result of the DescribeCommands operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeDeployments

        public DescribeDeploymentsResult describeDeployments​(DescribeDeploymentsRequest describeDeploymentsRequest)

        Requests a description of a specified set of deployments.

        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.

        Specified by:
        describeDeployments in interface AWSOpsWorks
        Parameters:
        describeDeploymentsRequest -
        Returns:
        Result of the DescribeDeployments operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeEcsClusters

        public DescribeEcsClustersResult describeEcsClusters​(DescribeEcsClustersRequest describeEcsClustersRequest)

        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 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.

        Specified by:
        describeEcsClusters in interface AWSOpsWorks
        Parameters:
        describeEcsClustersRequest -
        Returns:
        Result of the DescribeEcsClusters operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeInstances

        public DescribeInstancesResult describeInstances​(DescribeInstancesRequest describeInstancesRequest)

        Requests a description of a set of 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.

        Specified by:
        describeInstances in interface AWSOpsWorks
        Parameters:
        describeInstancesRequest -
        Returns:
        Result of the DescribeInstances operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeLayers

        public DescribeLayersResult describeLayers​(DescribeLayersRequest describeLayersRequest)

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

        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.

        Specified by:
        describeLayers in interface AWSOpsWorks
        Parameters:
        describeLayersRequest -
        Returns:
        Result of the DescribeLayers operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeLoadBasedAutoScaling

        public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling​(DescribeLoadBasedAutoScalingRequest describeLoadBasedAutoScalingRequest)

        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.

        Specified by:
        describeLoadBasedAutoScaling in interface AWSOpsWorks
        Parameters:
        describeLoadBasedAutoScalingRequest -
        Returns:
        Result of the DescribeLoadBasedAutoScaling operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeMyUserProfile

        public DescribeMyUserProfileResult describeMyUserProfile​(DescribeMyUserProfileRequest describeMyUserProfileRequest)

        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.

        Specified by:
        describeMyUserProfile in interface AWSOpsWorks
        Parameters:
        describeMyUserProfileRequest -
        Returns:
        Result of the DescribeMyUserProfile operation returned by the service.

      • describeRaidArrays

        public DescribeRaidArraysResult describeRaidArrays​(DescribeRaidArraysRequest describeRaidArraysRequest)

        Describe an instance's RAID arrays.

        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.

        Specified by:
        describeRaidArrays in interface AWSOpsWorks
        Parameters:
        describeRaidArraysRequest -
        Returns:
        Result of the DescribeRaidArrays operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeStackSummary

        public DescribeStackSummaryResult 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.

        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.

        Specified by:
        describeStackSummary in interface AWSOpsWorks
        Parameters:
        describeStackSummaryRequest -
        Returns:
        Result of the DescribeStackSummary operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeStacks

        public DescribeStacksResult describeStacks​(DescribeStacksRequest describeStacksRequest)

        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.

        Specified by:
        describeStacks in interface AWSOpsWorks
        Parameters:
        describeStacksRequest -
        Returns:
        Result of the DescribeStacks operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeTimeBasedAutoScaling

        public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling​(DescribeTimeBasedAutoScalingRequest describeTimeBasedAutoScalingRequest)

        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.

        Specified by:
        describeTimeBasedAutoScaling in interface AWSOpsWorks
        Parameters:
        describeTimeBasedAutoScalingRequest -
        Returns:
        Result of the DescribeTimeBasedAutoScaling operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • describeVolumes

        public DescribeVolumesResult describeVolumes​(DescribeVolumesRequest describeVolumesRequest)

        Describes an instance's Amazon EBS volumes.

        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.

        Specified by:
        describeVolumes in interface AWSOpsWorks
        Parameters:
        describeVolumesRequest -
        Returns:
        Result of the DescribeVolumes operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • detachElasticLoadBalancer

        public DetachElasticLoadBalancerResult detachElasticLoadBalancer​(DetachElasticLoadBalancerRequest detachElasticLoadBalancerRequest)

        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.

        Specified by:
        detachElasticLoadBalancer in interface AWSOpsWorks
        Parameters:
        detachElasticLoadBalancerRequest -
        Returns:
        Result of the DetachElasticLoadBalancer operation returned by the service.
        Throws:
        ResourceNotFoundException - Indicates that a resource was not found.

      • getHostnameSuggestion

        public GetHostnameSuggestionResult getHostnameSuggestion​(GetHostnameSuggestionRequest getHostnameSuggestionRequest)

        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.

        Specified by:
        getHostnameSuggestion in interface AWSOpsWorks
        Parameters:
        getHostnameSuggestionRequest -
        Returns:
        Result of the GetHostnameSuggestion operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • grantAccess

        public GrantAccessResult grantAccess​(GrantAccessRequest grantAccessRequest)
        This action can be used only with Windows stacks.

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

        Specified by:
        grantAccess in interface AWSOpsWorks
        Parameters:
        grantAccessRequest -
        Returns:
        Result of the GrantAccess operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • registerEcsCluster

        public RegisterEcsClusterResult registerEcsCluster​(RegisterEcsClusterRequest registerEcsClusterRequest)

        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.

        Specified by:
        registerEcsCluster in interface AWSOpsWorks
        Parameters:
        registerEcsClusterRequest -
        Returns:
        Result of the RegisterEcsCluster operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • registerElasticIp

        public RegisterElasticIpResult registerElasticIp​(RegisterElasticIpRequest registerElasticIpRequest)

        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.

        Specified by:
        registerElasticIp in interface AWSOpsWorks
        Parameters:
        registerElasticIpRequest -
        Returns:
        Result of the RegisterElasticIp operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • registerInstance

        public RegisterInstanceResult registerInstance​(RegisterInstanceRequest registerInstanceRequest)

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

        We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks 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 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.

        Specified by:
        registerInstance in interface AWSOpsWorks
        Parameters:
        registerInstanceRequest -
        Returns:
        Result of the RegisterInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • registerVolume

        public RegisterVolumeResult registerVolume​(RegisterVolumeRequest registerVolumeRequest)

        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.

        Specified by:
        registerVolume in interface AWSOpsWorks
        Parameters:
        registerVolumeRequest -
        Returns:
        Result of the RegisterVolume operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • setLoadBasedAutoScaling

        public SetLoadBasedAutoScalingResult setLoadBasedAutoScaling​(SetLoadBasedAutoScalingRequest setLoadBasedAutoScalingRequest)

        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.

        Specified by:
        setLoadBasedAutoScaling in interface AWSOpsWorks
        Parameters:
        setLoadBasedAutoScalingRequest -
        Returns:
        Result of the SetLoadBasedAutoScaling operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • startStack

        public StartStackResult startStack​(StartStackRequest startStackRequest)

        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.

        Specified by:
        startStack in interface AWSOpsWorks
        Parameters:
        startStackRequest -
        Returns:
        Result of the StartStack operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • stopInstance

        public StopInstanceResult stopInstance​(StopInstanceRequest stopInstanceRequest)

        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.

        Specified by:
        stopInstance in interface AWSOpsWorks
        Parameters:
        stopInstanceRequest -
        Returns:
        Result of the StopInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • stopStack

        public StopStackResult stopStack​(StopStackRequest stopStackRequest)

        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.

        Specified by:
        stopStack in interface AWSOpsWorks
        Parameters:
        stopStackRequest -
        Returns:
        Result of the StopStack operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • unassignInstance

        public UnassignInstanceResult unassignInstance​(UnassignInstanceRequest unassignInstanceRequest)

        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.

        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.

        Specified by:
        unassignInstance in interface AWSOpsWorks
        Parameters:
        unassignInstanceRequest -
        Returns:
        Result of the UnassignInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • unassignVolume

        public UnassignVolumeResult unassignVolume​(UnassignVolumeRequest unassignVolumeRequest)

        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.

        Specified by:
        unassignVolume in interface AWSOpsWorks
        Parameters:
        unassignVolumeRequest -
        Returns:
        Result of the UnassignVolume operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • updateApp

        public UpdateAppResult updateApp​(UpdateAppRequest updateAppRequest)

        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.

        Specified by:
        updateApp in interface AWSOpsWorks
        Parameters:
        updateAppRequest -
        Returns:
        Result of the UpdateApp operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • updateInstance

        public UpdateInstanceResult updateInstance​(UpdateInstanceRequest updateInstanceRequest)

        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.

        Specified by:
        updateInstance in interface AWSOpsWorks
        Parameters:
        updateInstanceRequest -
        Returns:
        Result of the UpdateInstance operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • updateLayer

        public UpdateLayerResult updateLayer​(UpdateLayerRequest updateLayerRequest)

        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.

        Specified by:
        updateLayer in interface AWSOpsWorks
        Parameters:
        updateLayerRequest -
        Returns:
        Result of the UpdateLayer operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • updateMyUserProfile

        public UpdateMyUserProfileResult updateMyUserProfile​(UpdateMyUserProfileRequest updateMyUserProfileRequest)

        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.

        Specified by:
        updateMyUserProfile in interface AWSOpsWorks
        Parameters:
        updateMyUserProfileRequest -
        Returns:
        Result of the UpdateMyUserProfile operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.

      • updateStack

        public UpdateStackResult updateStack​(UpdateStackRequest updateStackRequest)

        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.

        Specified by:
        updateStack in interface AWSOpsWorks
        Parameters:
        updateStackRequest -
        Returns:
        Result of the UpdateStack operation returned by the service.
        Throws:
        ValidationException - Indicates that a request was invalid.
        ResourceNotFoundException - Indicates that a resource was not found.

      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AWSOpsWorks
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.