Skip to content

OpsWorksClient

Index > OpsWorks > OpsWorksClient

Auto-generated documentation for OpsWorks type annotations stubs module mypy-boto3-opsworks.

OpsWorksClient

Type annotations and code completion for boto3.client("opsworks"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_opsworks.client import OpsWorksClient

def get_opsworks_client() -> OpsWorksClient:
    return Session().client("opsworks")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("opsworks").exceptions structure.

Usage example
client = boto3.client("opsworks")

try:
    do_something(client)
except (
    client.ClientError,
    client.ResourceNotFoundException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_opsworks.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

assign_instance

Assign a registered instance to a layer.

Type annotations and code completion for boto3.client("opsworks").assign_instance method. boto3 documentation

Method definition
def assign_instance(
    self,
    *,
    InstanceId: str,
    LayerIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssignInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "LayerIds": ...,
}

parent.assign_instance(**kwargs)
  1. See AssignInstanceRequestRequestTypeDef

assign_volume

Assigns one of the stack's registered Amazon EBS volumes to a specified instance.

Type annotations and code completion for boto3.client("opsworks").assign_volume method. boto3 documentation

Method definition
def assign_volume(
    self,
    *,
    VolumeId: str,
    InstanceId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssignVolumeRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.assign_volume(**kwargs)
  1. See AssignVolumeRequestRequestTypeDef

associate_elastic_ip

Associates one of the stack's registered Elastic IP addresses with a specified instance.

Type annotations and code completion for boto3.client("opsworks").associate_elastic_ip method. boto3 documentation

Method definition
def associate_elastic_ip(
    self,
    *,
    ElasticIp: str,
    InstanceId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateElasticIpRequestRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.associate_elastic_ip(**kwargs)
  1. See AssociateElasticIpRequestRequestTypeDef

attach_elastic_load_balancer

Attaches an Elastic Load Balancing load balancer to a specified layer.

Type annotations and code completion for boto3.client("opsworks").attach_elastic_load_balancer method. boto3 documentation

Method definition
def attach_elastic_load_balancer(
    self,
    *,
    ElasticLoadBalancerName: str,
    LayerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AttachElasticLoadBalancerRequestRequestTypeDef = {  # (1)
    "ElasticLoadBalancerName": ...,
    "LayerId": ...,
}

parent.attach_elastic_load_balancer(**kwargs)
  1. See AttachElasticLoadBalancerRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("opsworks").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

clone_stack

Creates a clone of a specified stack.

Type annotations and code completion for boto3.client("opsworks").clone_stack method. boto3 documentation

Method definition
def clone_stack(
    self,
    *,
    SourceStackId: str,
    ServiceRoleArn: str,
    Name: str = ...,
    Region: str = ...,
    VpcId: str = ...,
    Attributes: Mapping[StackAttributesKeysType, str] = ...,  # (1)
    DefaultInstanceProfileArn: str = ...,
    DefaultOs: str = ...,
    HostnameTheme: str = ...,
    DefaultAvailabilityZone: str = ...,
    DefaultSubnetId: str = ...,
    CustomJson: str = ...,
    ConfigurationManager: StackConfigurationManagerTypeDef = ...,  # (2)
    ChefConfiguration: ChefConfigurationTypeDef = ...,  # (3)
    UseCustomCookbooks: bool = ...,
    UseOpsworksSecurityGroups: bool = ...,
    CustomCookbooksSource: SourceTypeDef = ...,  # (4)
    DefaultSshKeyName: str = ...,
    ClonePermissions: bool = ...,
    CloneAppIds: Sequence[str] = ...,
    DefaultRootDeviceType: RootDeviceTypeType = ...,  # (5)
    AgentVersion: str = ...,
) -> CloneStackResultTypeDef:  # (6)
    ...
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType
  6. See CloneStackResultTypeDef
Usage example with kwargs
kwargs: CloneStackRequestRequestTypeDef = {  # (1)
    "SourceStackId": ...,
    "ServiceRoleArn": ...,
}

parent.clone_stack(**kwargs)
  1. See CloneStackRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("opsworks").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_app

Creates an app for a specified stack.

Type annotations and code completion for boto3.client("opsworks").create_app method. boto3 documentation

Method definition
def create_app(
    self,
    *,
    StackId: str,
    Name: str,
    Type: AppTypeType,  # (1)
    Shortname: str = ...,
    Description: str = ...,
    DataSources: Sequence[DataSourceTypeDef] = ...,  # (2)
    AppSource: SourceTypeDef = ...,  # (3)
    Domains: Sequence[str] = ...,
    EnableSsl: bool = ...,
    SslConfiguration: SslConfigurationTypeDef = ...,  # (4)
    Attributes: Mapping[AppAttributesKeysType, str] = ...,  # (5)
    Environment: Sequence[EnvironmentVariableTypeDef] = ...,  # (6)
) -> CreateAppResultTypeDef:  # (7)
    ...
  1. See AppTypeType
  2. See DataSourceTypeDef
  3. See SourceTypeDef
  4. See SslConfigurationTypeDef
  5. See AppAttributesKeysType
  6. See EnvironmentVariableTypeDef
  7. See CreateAppResultTypeDef
Usage example with kwargs
kwargs: CreateAppRequestRequestTypeDef = {  # (1)
    "StackId": ...,
    "Name": ...,
    "Type": ...,
}

parent.create_app(**kwargs)
  1. See CreateAppRequestRequestTypeDef

create_deployment

Runs deployment or stack commands.

Type annotations and code completion for boto3.client("opsworks").create_deployment method. boto3 documentation

Method definition
def create_deployment(
    self,
    *,
    StackId: str,
    Command: DeploymentCommandTypeDef,  # (1)
    AppId: str = ...,
    InstanceIds: Sequence[str] = ...,
    LayerIds: Sequence[str] = ...,
    Comment: str = ...,
    CustomJson: str = ...,
) -> CreateDeploymentResultTypeDef:  # (2)
    ...
  1. See DeploymentCommandTypeDef
  2. See CreateDeploymentResultTypeDef
Usage example with kwargs
kwargs: CreateDeploymentRequestRequestTypeDef = {  # (1)
    "StackId": ...,
    "Command": ...,
}

parent.create_deployment(**kwargs)
  1. See CreateDeploymentRequestRequestTypeDef

create_instance

Creates an instance in a specified stack.

Type annotations and code completion for boto3.client("opsworks").create_instance method. boto3 documentation

Method definition
def create_instance(
    self,
    *,
    StackId: str,
    LayerIds: Sequence[str],
    InstanceType: str,
    AutoScalingType: AutoScalingTypeType = ...,  # (1)
    Hostname: str = ...,
    Os: str = ...,
    AmiId: str = ...,
    SshKeyName: str = ...,
    AvailabilityZone: str = ...,
    VirtualizationType: str = ...,
    SubnetId: str = ...,
    Architecture: ArchitectureType = ...,  # (2)
    RootDeviceType: RootDeviceTypeType = ...,  # (3)
    BlockDeviceMappings: Sequence[BlockDeviceMappingTypeDef] = ...,  # (4)
    InstallUpdatesOnBoot: bool = ...,
    EbsOptimized: bool = ...,
    AgentVersion: str = ...,
    Tenancy: str = ...,
) -> CreateInstanceResultTypeDef:  # (5)
    ...
  1. See AutoScalingTypeType
  2. See ArchitectureType
  3. See RootDeviceTypeType
  4. See BlockDeviceMappingTypeDef
  5. See CreateInstanceResultTypeDef
Usage example with kwargs
kwargs: CreateInstanceRequestRequestTypeDef = {  # (1)
    "StackId": ...,
    "LayerIds": ...,
    "InstanceType": ...,
}

parent.create_instance(**kwargs)
  1. See CreateInstanceRequestRequestTypeDef

create_layer

Creates a layer.

Type annotations and code completion for boto3.client("opsworks").create_layer method. boto3 documentation

Method definition
def create_layer(
    self,
    *,
    StackId: str,
    Type: LayerTypeType,  # (1)
    Name: str,
    Shortname: str,
    Attributes: Mapping[LayerAttributesKeysType, str] = ...,  # (2)
    CloudWatchLogsConfiguration: CloudWatchLogsConfigurationTypeDef = ...,  # (3)
    CustomInstanceProfileArn: str = ...,
    CustomJson: str = ...,
    CustomSecurityGroupIds: Sequence[str] = ...,
    Packages: Sequence[str] = ...,
    VolumeConfigurations: Sequence[VolumeConfigurationTypeDef] = ...,  # (4)
    EnableAutoHealing: bool = ...,
    AutoAssignElasticIps: bool = ...,
    AutoAssignPublicIps: bool = ...,
    CustomRecipes: RecipesTypeDef = ...,  # (5)
    InstallUpdatesOnBoot: bool = ...,
    UseEbsOptimizedInstances: bool = ...,
    LifecycleEventConfiguration: LifecycleEventConfigurationTypeDef = ...,  # (6)
) -> CreateLayerResultTypeDef:  # (7)
    ...
  1. See LayerTypeType
  2. See LayerAttributesKeysType
  3. See CloudWatchLogsConfigurationTypeDef
  4. See VolumeConfigurationTypeDef
  5. See RecipesTypeDef
  6. See LifecycleEventConfigurationTypeDef
  7. See CreateLayerResultTypeDef
Usage example with kwargs
kwargs: CreateLayerRequestRequestTypeDef = {  # (1)
    "StackId": ...,
    "Type": ...,
    "Name": ...,
    "Shortname": ...,
}

parent.create_layer(**kwargs)
  1. See CreateLayerRequestRequestTypeDef

create_stack

Creates a new stack.

Type annotations and code completion for boto3.client("opsworks").create_stack method. boto3 documentation

Method definition
def create_stack(
    self,
    *,
    Name: str,
    Region: str,
    ServiceRoleArn: str,
    DefaultInstanceProfileArn: str,
    VpcId: str = ...,
    Attributes: Mapping[StackAttributesKeysType, str] = ...,  # (1)
    DefaultOs: str = ...,
    HostnameTheme: str = ...,
    DefaultAvailabilityZone: str = ...,
    DefaultSubnetId: str = ...,
    CustomJson: str = ...,
    ConfigurationManager: StackConfigurationManagerTypeDef = ...,  # (2)
    ChefConfiguration: ChefConfigurationTypeDef = ...,  # (3)
    UseCustomCookbooks: bool = ...,
    UseOpsworksSecurityGroups: bool = ...,
    CustomCookbooksSource: SourceTypeDef = ...,  # (4)
    DefaultSshKeyName: str = ...,
    DefaultRootDeviceType: RootDeviceTypeType = ...,  # (5)
    AgentVersion: str = ...,
) -> CreateStackResultTypeDef:  # (6)
    ...
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType
  6. See CreateStackResultTypeDef
Usage example with kwargs
kwargs: CreateStackRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Region": ...,
    "ServiceRoleArn": ...,
    "DefaultInstanceProfileArn": ...,
}

parent.create_stack(**kwargs)
  1. See CreateStackRequestRequestTypeDef

create_user_profile

Creates a new user profile.

Type annotations and code completion for boto3.client("opsworks").create_user_profile method. boto3 documentation

Method definition
def create_user_profile(
    self,
    *,
    IamUserArn: str,
    SshUsername: str = ...,
    SshPublicKey: str = ...,
    AllowSelfManagement: bool = ...,
) -> CreateUserProfileResultTypeDef:  # (1)
    ...
  1. See CreateUserProfileResultTypeDef
Usage example with kwargs
kwargs: CreateUserProfileRequestRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.create_user_profile(**kwargs)
  1. See CreateUserProfileRequestRequestTypeDef

delete_app

Deletes a specified app.

Type annotations and code completion for boto3.client("opsworks").delete_app method. boto3 documentation

Method definition
def delete_app(
    self,
    *,
    AppId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteAppRequestRequestTypeDef = {  # (1)
    "AppId": ...,
}

parent.delete_app(**kwargs)
  1. See DeleteAppRequestRequestTypeDef

delete_instance

Deletes a specified instance, which terminates the associated Amazon EC2 instance.

Type annotations and code completion for boto3.client("opsworks").delete_instance method. boto3 documentation

Method definition
def delete_instance(
    self,
    *,
    InstanceId: str,
    DeleteElasticIp: bool = ...,
    DeleteVolumes: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.delete_instance(**kwargs)
  1. See DeleteInstanceRequestRequestTypeDef

delete_layer

Deletes a specified layer.

Type annotations and code completion for boto3.client("opsworks").delete_layer method. boto3 documentation

Method definition
def delete_layer(
    self,
    *,
    LayerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteLayerRequestRequestTypeDef = {  # (1)
    "LayerId": ...,
}

parent.delete_layer(**kwargs)
  1. See DeleteLayerRequestRequestTypeDef

delete_stack

Deletes a specified stack.

Type annotations and code completion for boto3.client("opsworks").delete_stack method. boto3 documentation

Method definition
def delete_stack(
    self,
    *,
    StackId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteStackRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.delete_stack(**kwargs)
  1. See DeleteStackRequestRequestTypeDef

delete_user_profile

Deletes a user profile.

Type annotations and code completion for boto3.client("opsworks").delete_user_profile method. boto3 documentation

Method definition
def delete_user_profile(
    self,
    *,
    IamUserArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserProfileRequestRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.delete_user_profile(**kwargs)
  1. See DeleteUserProfileRequestRequestTypeDef

deregister_ecs_cluster

Deregisters a specified Amazon ECS cluster from a stack.

Type annotations and code completion for boto3.client("opsworks").deregister_ecs_cluster method. boto3 documentation

Method definition
def deregister_ecs_cluster(
    self,
    *,
    EcsClusterArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterEcsClusterRequestRequestTypeDef = {  # (1)
    "EcsClusterArn": ...,
}

parent.deregister_ecs_cluster(**kwargs)
  1. See DeregisterEcsClusterRequestRequestTypeDef

deregister_elastic_ip

Deregisters a specified Elastic IP address.

Type annotations and code completion for boto3.client("opsworks").deregister_elastic_ip method. boto3 documentation

Method definition
def deregister_elastic_ip(
    self,
    *,
    ElasticIp: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterElasticIpRequestRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.deregister_elastic_ip(**kwargs)
  1. See DeregisterElasticIpRequestRequestTypeDef

deregister_instance

Deregister a registered Amazon EC2 or on-premises instance.

Type annotations and code completion for boto3.client("opsworks").deregister_instance method. boto3 documentation

Method definition
def deregister_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.deregister_instance(**kwargs)
  1. See DeregisterInstanceRequestRequestTypeDef

deregister_rds_db_instance

Deregisters an Amazon RDS instance.

Type annotations and code completion for boto3.client("opsworks").deregister_rds_db_instance method. boto3 documentation

Method definition
def deregister_rds_db_instance(
    self,
    *,
    RdsDbInstanceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterRdsDbInstanceRequestRequestTypeDef = {  # (1)
    "RdsDbInstanceArn": ...,
}

parent.deregister_rds_db_instance(**kwargs)
  1. See DeregisterRdsDbInstanceRequestRequestTypeDef

deregister_volume

Deregisters an Amazon EBS volume.

Type annotations and code completion for boto3.client("opsworks").deregister_volume method. boto3 documentation

Method definition
def deregister_volume(
    self,
    *,
    VolumeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeregisterVolumeRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.deregister_volume(**kwargs)
  1. See DeregisterVolumeRequestRequestTypeDef

describe_agent_versions

Describes the available AWS OpsWorks Stacks agent versions.

Type annotations and code completion for boto3.client("opsworks").describe_agent_versions method. boto3 documentation

Method definition
def describe_agent_versions(
    self,
    *,
    StackId: str = ...,
    ConfigurationManager: StackConfigurationManagerTypeDef = ...,  # (1)
) -> DescribeAgentVersionsResultTypeDef:  # (2)
    ...
  1. See StackConfigurationManagerTypeDef
  2. See DescribeAgentVersionsResultTypeDef
Usage example with kwargs
kwargs: DescribeAgentVersionsRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_agent_versions(**kwargs)
  1. See DescribeAgentVersionsRequestRequestTypeDef

describe_apps

Requests a description of a specified set of apps.

Type annotations and code completion for boto3.client("opsworks").describe_apps method. boto3 documentation

Method definition
def describe_apps(
    self,
    *,
    StackId: str = ...,
    AppIds: Sequence[str] = ...,
) -> DescribeAppsResultTypeDef:  # (1)
    ...
  1. See DescribeAppsResultTypeDef
Usage example with kwargs
kwargs: DescribeAppsRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_apps(**kwargs)
  1. See DescribeAppsRequestRequestTypeDef

describe_commands

Describes the results of specified commands.

Type annotations and code completion for boto3.client("opsworks").describe_commands method. boto3 documentation

Method definition
def describe_commands(
    self,
    *,
    DeploymentId: str = ...,
    InstanceId: str = ...,
    CommandIds: Sequence[str] = ...,
) -> DescribeCommandsResultTypeDef:  # (1)
    ...
  1. See DescribeCommandsResultTypeDef
Usage example with kwargs
kwargs: DescribeCommandsRequestRequestTypeDef = {  # (1)
    "DeploymentId": ...,
}

parent.describe_commands(**kwargs)
  1. See DescribeCommandsRequestRequestTypeDef

describe_deployments

Requests a description of a specified set of deployments.

Type annotations and code completion for boto3.client("opsworks").describe_deployments method. boto3 documentation

Method definition
def describe_deployments(
    self,
    *,
    StackId: str = ...,
    AppId: str = ...,
    DeploymentIds: Sequence[str] = ...,
) -> DescribeDeploymentsResultTypeDef:  # (1)
    ...
  1. See DescribeDeploymentsResultTypeDef
Usage example with kwargs
kwargs: DescribeDeploymentsRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_deployments(**kwargs)
  1. See DescribeDeploymentsRequestRequestTypeDef

describe_ecs_clusters

Describes Amazon ECS clusters that are registered with a stack.

Type annotations and code completion for boto3.client("opsworks").describe_ecs_clusters method. boto3 documentation

Method definition
def describe_ecs_clusters(
    self,
    *,
    EcsClusterArns: Sequence[str] = ...,
    StackId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeEcsClustersResultTypeDef:  # (1)
    ...
  1. See DescribeEcsClustersResultTypeDef
Usage example with kwargs
kwargs: DescribeEcsClustersRequestRequestTypeDef = {  # (1)
    "EcsClusterArns": ...,
}

parent.describe_ecs_clusters(**kwargs)
  1. See DescribeEcsClustersRequestRequestTypeDef

describe_elastic_ips

Describes Elastic IP addresses_ .

Type annotations and code completion for boto3.client("opsworks").describe_elastic_ips method. boto3 documentation

Method definition
def describe_elastic_ips(
    self,
    *,
    InstanceId: str = ...,
    StackId: str = ...,
    Ips: Sequence[str] = ...,
) -> DescribeElasticIpsResultTypeDef:  # (1)
    ...
  1. See DescribeElasticIpsResultTypeDef
Usage example with kwargs
kwargs: DescribeElasticIpsRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_elastic_ips(**kwargs)
  1. See DescribeElasticIpsRequestRequestTypeDef

describe_elastic_load_balancers

Describes a stack's Elastic Load Balancing instances.

Type annotations and code completion for boto3.client("opsworks").describe_elastic_load_balancers method. boto3 documentation

Method definition
def describe_elastic_load_balancers(
    self,
    *,
    StackId: str = ...,
    LayerIds: Sequence[str] = ...,
) -> DescribeElasticLoadBalancersResultTypeDef:  # (1)
    ...
  1. See DescribeElasticLoadBalancersResultTypeDef
Usage example with kwargs
kwargs: DescribeElasticLoadBalancersRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_elastic_load_balancers(**kwargs)
  1. See DescribeElasticLoadBalancersRequestRequestTypeDef

describe_instances

Requests a description of a set of instances.

Type annotations and code completion for boto3.client("opsworks").describe_instances method. boto3 documentation

Method definition
def describe_instances(
    self,
    *,
    StackId: str = ...,
    LayerId: str = ...,
    InstanceIds: Sequence[str] = ...,
) -> DescribeInstancesResultTypeDef:  # (1)
    ...
  1. See DescribeInstancesResultTypeDef
Usage example with kwargs
kwargs: DescribeInstancesRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_instances(**kwargs)
  1. See DescribeInstancesRequestRequestTypeDef

describe_layers

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

Type annotations and code completion for boto3.client("opsworks").describe_layers method. boto3 documentation

Method definition
def describe_layers(
    self,
    *,
    StackId: str = ...,
    LayerIds: Sequence[str] = ...,
) -> DescribeLayersResultTypeDef:  # (1)
    ...
  1. See DescribeLayersResultTypeDef
Usage example with kwargs
kwargs: DescribeLayersRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_layers(**kwargs)
  1. See DescribeLayersRequestRequestTypeDef

describe_load_based_auto_scaling

Describes load-based auto scaling configurations for specified layers.

Type annotations and code completion for boto3.client("opsworks").describe_load_based_auto_scaling method. boto3 documentation

Method definition
def describe_load_based_auto_scaling(
    self,
    *,
    LayerIds: Sequence[str],
) -> DescribeLoadBasedAutoScalingResultTypeDef:  # (1)
    ...
  1. See DescribeLoadBasedAutoScalingResultTypeDef
Usage example with kwargs
kwargs: DescribeLoadBasedAutoScalingRequestRequestTypeDef = {  # (1)
    "LayerIds": ...,
}

parent.describe_load_based_auto_scaling(**kwargs)
  1. See DescribeLoadBasedAutoScalingRequestRequestTypeDef

describe_my_user_profile

Describes a user's SSH information.

Type annotations and code completion for boto3.client("opsworks").describe_my_user_profile method. boto3 documentation

Method definition
def describe_my_user_profile(
    self,
) -> DescribeMyUserProfileResultTypeDef:  # (1)
    ...
  1. See DescribeMyUserProfileResultTypeDef

describe_operating_systems

Describes the operating systems that are supported by AWS OpsWorks Stacks.

Type annotations and code completion for boto3.client("opsworks").describe_operating_systems method. boto3 documentation

Method definition
def describe_operating_systems(
    self,
) -> DescribeOperatingSystemsResponseTypeDef:  # (1)
    ...
  1. See DescribeOperatingSystemsResponseTypeDef

describe_permissions

Describes the permissions for a specified stack.

Type annotations and code completion for boto3.client("opsworks").describe_permissions method. boto3 documentation

Method definition
def describe_permissions(
    self,
    *,
    IamUserArn: str = ...,
    StackId: str = ...,
) -> DescribePermissionsResultTypeDef:  # (1)
    ...
  1. See DescribePermissionsResultTypeDef
Usage example with kwargs
kwargs: DescribePermissionsRequestRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.describe_permissions(**kwargs)
  1. See DescribePermissionsRequestRequestTypeDef

describe_raid_arrays

Describe an instance's RAID arrays.

Type annotations and code completion for boto3.client("opsworks").describe_raid_arrays method. boto3 documentation

Method definition
def describe_raid_arrays(
    self,
    *,
    InstanceId: str = ...,
    StackId: str = ...,
    RaidArrayIds: Sequence[str] = ...,
) -> DescribeRaidArraysResultTypeDef:  # (1)
    ...
  1. See DescribeRaidArraysResultTypeDef
Usage example with kwargs
kwargs: DescribeRaidArraysRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_raid_arrays(**kwargs)
  1. See DescribeRaidArraysRequestRequestTypeDef

describe_rds_db_instances

Describes Amazon RDS instances.

Type annotations and code completion for boto3.client("opsworks").describe_rds_db_instances method. boto3 documentation

Method definition
def describe_rds_db_instances(
    self,
    *,
    StackId: str,
    RdsDbInstanceArns: Sequence[str] = ...,
) -> DescribeRdsDbInstancesResultTypeDef:  # (1)
    ...
  1. See DescribeRdsDbInstancesResultTypeDef
Usage example with kwargs
kwargs: DescribeRdsDbInstancesRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_rds_db_instances(**kwargs)
  1. See DescribeRdsDbInstancesRequestRequestTypeDef

describe_service_errors

Describes AWS OpsWorks Stacks service errors.

Type annotations and code completion for boto3.client("opsworks").describe_service_errors method. boto3 documentation

Method definition
def describe_service_errors(
    self,
    *,
    StackId: str = ...,
    InstanceId: str = ...,
    ServiceErrorIds: Sequence[str] = ...,
) -> DescribeServiceErrorsResultTypeDef:  # (1)
    ...
  1. See DescribeServiceErrorsResultTypeDef
Usage example with kwargs
kwargs: DescribeServiceErrorsRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_service_errors(**kwargs)
  1. See DescribeServiceErrorsRequestRequestTypeDef

describe_stack_provisioning_parameters

Requests a description of a stack's provisioning parameters.

Type annotations and code completion for boto3.client("opsworks").describe_stack_provisioning_parameters method. boto3 documentation

Method definition
def describe_stack_provisioning_parameters(
    self,
    *,
    StackId: str,
) -> DescribeStackProvisioningParametersResultTypeDef:  # (1)
    ...
  1. See DescribeStackProvisioningParametersResultTypeDef
Usage example with kwargs
kwargs: DescribeStackProvisioningParametersRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_stack_provisioning_parameters(**kwargs)
  1. See DescribeStackProvisioningParametersRequestRequestTypeDef

describe_stack_summary

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 .

Type annotations and code completion for boto3.client("opsworks").describe_stack_summary method. boto3 documentation

Method definition
def describe_stack_summary(
    self,
    *,
    StackId: str,
) -> DescribeStackSummaryResultTypeDef:  # (1)
    ...
  1. See DescribeStackSummaryResultTypeDef
Usage example with kwargs
kwargs: DescribeStackSummaryRequestRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_stack_summary(**kwargs)
  1. See DescribeStackSummaryRequestRequestTypeDef

describe_stacks

Requests a description of one or more stacks.

Type annotations and code completion for boto3.client("opsworks").describe_stacks method. boto3 documentation

Method definition
def describe_stacks(
    self,
    *,
    StackIds: Sequence[str] = ...,
) -> DescribeStacksResultTypeDef:  # (1)
    ...
  1. See DescribeStacksResultTypeDef
Usage example with kwargs
kwargs: DescribeStacksRequestRequestTypeDef = {  # (1)
    "StackIds": ...,
}

parent.describe_stacks(**kwargs)
  1. See DescribeStacksRequestRequestTypeDef

describe_time_based_auto_scaling

Describes time-based auto scaling configurations for specified instances.

Type annotations and code completion for boto3.client("opsworks").describe_time_based_auto_scaling method. boto3 documentation

Method definition
def describe_time_based_auto_scaling(
    self,
    *,
    InstanceIds: Sequence[str],
) -> DescribeTimeBasedAutoScalingResultTypeDef:  # (1)
    ...
  1. See DescribeTimeBasedAutoScalingResultTypeDef
Usage example with kwargs
kwargs: DescribeTimeBasedAutoScalingRequestRequestTypeDef = {  # (1)
    "InstanceIds": ...,
}

parent.describe_time_based_auto_scaling(**kwargs)
  1. See DescribeTimeBasedAutoScalingRequestRequestTypeDef

describe_user_profiles

Describe specified users.

Type annotations and code completion for boto3.client("opsworks").describe_user_profiles method. boto3 documentation

Method definition
def describe_user_profiles(
    self,
    *,
    IamUserArns: Sequence[str] = ...,
) -> DescribeUserProfilesResultTypeDef:  # (1)
    ...
  1. See DescribeUserProfilesResultTypeDef
Usage example with kwargs
kwargs: DescribeUserProfilesRequestRequestTypeDef = {  # (1)
    "IamUserArns": ...,
}

parent.describe_user_profiles(**kwargs)
  1. See DescribeUserProfilesRequestRequestTypeDef

describe_volumes

Describes an instance's Amazon EBS volumes.

Type annotations and code completion for boto3.client("opsworks").describe_volumes method. boto3 documentation

Method definition
def describe_volumes(
    self,
    *,
    InstanceId: str = ...,
    StackId: str = ...,
    RaidArrayId: str = ...,
    VolumeIds: Sequence[str] = ...,
) -> DescribeVolumesResultTypeDef:  # (1)
    ...
  1. See DescribeVolumesResultTypeDef
Usage example with kwargs
kwargs: DescribeVolumesRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_volumes(**kwargs)
  1. See DescribeVolumesRequestRequestTypeDef

detach_elastic_load_balancer

Detaches a specified Elastic Load Balancing instance from its layer.

Type annotations and code completion for boto3.client("opsworks").detach_elastic_load_balancer method. boto3 documentation

Method definition
def detach_elastic_load_balancer(
    self,
    *,
    ElasticLoadBalancerName: str,
    LayerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DetachElasticLoadBalancerRequestRequestTypeDef = {  # (1)
    "ElasticLoadBalancerName": ...,
    "LayerId": ...,
}

parent.detach_elastic_load_balancer(**kwargs)
  1. See DetachElasticLoadBalancerRequestRequestTypeDef

disassociate_elastic_ip

Disassociates an Elastic IP address from its instance.

Type annotations and code completion for boto3.client("opsworks").disassociate_elastic_ip method. boto3 documentation

Method definition
def disassociate_elastic_ip(
    self,
    *,
    ElasticIp: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisassociateElasticIpRequestRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.disassociate_elastic_ip(**kwargs)
  1. See DisassociateElasticIpRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("opsworks").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_hostname_suggestion

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

Type annotations and code completion for boto3.client("opsworks").get_hostname_suggestion method. boto3 documentation

Method definition
def get_hostname_suggestion(
    self,
    *,
    LayerId: str,
) -> GetHostnameSuggestionResultTypeDef:  # (1)
    ...
  1. See GetHostnameSuggestionResultTypeDef
Usage example with kwargs
kwargs: GetHostnameSuggestionRequestRequestTypeDef = {  # (1)
    "LayerId": ...,
}

parent.get_hostname_suggestion(**kwargs)
  1. See GetHostnameSuggestionRequestRequestTypeDef

grant_access

.

Type annotations and code completion for boto3.client("opsworks").grant_access method. boto3 documentation

Method definition
def grant_access(
    self,
    *,
    InstanceId: str,
    ValidForInMinutes: int = ...,
) -> GrantAccessResultTypeDef:  # (1)
    ...
  1. See GrantAccessResultTypeDef
Usage example with kwargs
kwargs: GrantAccessRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.grant_access(**kwargs)
  1. See GrantAccessRequestRequestTypeDef

list_tags

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

Type annotations and code completion for boto3.client("opsworks").list_tags method. boto3 documentation

Method definition
def list_tags(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsResultTypeDef:  # (1)
    ...
  1. See ListTagsResultTypeDef
Usage example with kwargs
kwargs: ListTagsRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsRequestRequestTypeDef

reboot_instance

Reboots a specified instance.

Type annotations and code completion for boto3.client("opsworks").reboot_instance method. boto3 documentation

Method definition
def reboot_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: RebootInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.reboot_instance(**kwargs)
  1. See RebootInstanceRequestRequestTypeDef

register_ecs_cluster

Registers a specified Amazon ECS cluster with a stack.

Type annotations and code completion for boto3.client("opsworks").register_ecs_cluster method. boto3 documentation

Method definition