OpsWorksClient

Index > OpsWorks > OpsWorksClient

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

OpsWorksClient

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

# OpsWorksClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("opsworks")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_opsworks.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

assign_instance

Assign a registered instance to a layer.

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

# assign_instance method definition

def assign_instance(
    self,
    *,
    InstanceId: str,
    LayerIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# assign_instance method usage example with argument unpacking

kwargs: AssignInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "LayerIds": ...,
}

parent.assign_instance(**kwargs)

1. See AssignInstanceRequestTypeDef

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

# assign_volume method definition

def assign_volume(
    self,
    *,
    VolumeId: str,
    InstanceId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# assign_volume method usage example with argument unpacking

kwargs: AssignVolumeRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.assign_volume(**kwargs)

1. See AssignVolumeRequestTypeDef

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

# associate_elastic_ip method definition

def associate_elastic_ip(
    self,
    *,
    ElasticIp: str,
    InstanceId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# associate_elastic_ip method usage example with argument unpacking

kwargs: AssociateElasticIpRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.associate_elastic_ip(**kwargs)

1. See AssociateElasticIpRequestTypeDef

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

# attach_elastic_load_balancer method definition

def attach_elastic_load_balancer(
    self,
    *,
    ElasticLoadBalancerName: str,
    LayerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# attach_elastic_load_balancer method usage example with argument unpacking

kwargs: AttachElasticLoadBalancerRequestTypeDef = {  # (1)
    "ElasticLoadBalancerName": ...,
    "LayerId": ...,
}

parent.attach_elastic_load_balancer(**kwargs)

1. See AttachElasticLoadBalancerRequestTypeDef

clone_stack

Creates a clone of a specified stack.

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

# clone_stack 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

# clone_stack method usage example with argument unpacking

kwargs: CloneStackRequestTypeDef = {  # (1)
    "SourceStackId": ...,
    "ServiceRoleArn": ...,
}

parent.clone_stack(**kwargs)

1. See CloneStackRequestTypeDef

create_app

Creates an app for a specified stack.

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

# create_app 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

# create_app method usage example with argument unpacking

kwargs: CreateAppRequestTypeDef = {  # (1)
    "StackId": ...,
    "Name": ...,
    "Type": ...,
}

parent.create_app(**kwargs)

1. See CreateAppRequestTypeDef

create_deployment

Runs deployment or stack commands.

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

# create_deployment method definition

def create_deployment(
    self,
    *,
    StackId: str,
    Command: DeploymentCommandUnionTypeDef,  # (1)
    AppId: str = ...,
    InstanceIds: Sequence[str] = ...,
    LayerIds: Sequence[str] = ...,
    Comment: str = ...,
    CustomJson: str = ...,
) -> CreateDeploymentResultTypeDef:  # (2)
    ...

1. See DeploymentCommandTypeDef DeploymentCommandOutputTypeDef
2. See CreateDeploymentResultTypeDef

# create_deployment method usage example with argument unpacking

kwargs: CreateDeploymentRequestTypeDef = {  # (1)
    "StackId": ...,
    "Command": ...,
}

parent.create_deployment(**kwargs)

1. See CreateDeploymentRequestTypeDef

create_instance

Creates an instance in a specified stack.

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

# create_instance 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

# create_instance method usage example with argument unpacking

kwargs: CreateInstanceRequestTypeDef = {  # (1)
    "StackId": ...,
    "LayerIds": ...,
    "InstanceType": ...,
}

parent.create_instance(**kwargs)

1. See CreateInstanceRequestTypeDef

create_layer

Creates a layer.

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

# create_layer method definition

def create_layer(
    self,
    *,
    StackId: str,
    Type: LayerTypeType,  # (1)
    Name: str,
    Shortname: str,
    Attributes: Mapping[LayerAttributesKeysType, str] = ...,  # (2)
    CloudWatchLogsConfiguration: CloudWatchLogsConfigurationUnionTypeDef = ...,  # (3)
    CustomInstanceProfileArn: str = ...,
    CustomJson: str = ...,
    CustomSecurityGroupIds: Sequence[str] = ...,
    Packages: Sequence[str] = ...,
    VolumeConfigurations: Sequence[VolumeConfigurationTypeDef] = ...,  # (4)
    EnableAutoHealing: bool = ...,
    AutoAssignElasticIps: bool = ...,
    AutoAssignPublicIps: bool = ...,
    CustomRecipes: RecipesUnionTypeDef = ...,  # (5)
    InstallUpdatesOnBoot: bool = ...,
    UseEbsOptimizedInstances: bool = ...,
    LifecycleEventConfiguration: LifecycleEventConfigurationTypeDef = ...,  # (6)
) -> CreateLayerResultTypeDef:  # (7)
    ...

1. See LayerTypeType
2. See LayerAttributesKeysType
3. See CloudWatchLogsConfigurationTypeDef CloudWatchLogsConfigurationOutputTypeDef
4. See VolumeConfigurationTypeDef
5. See RecipesTypeDef RecipesOutputTypeDef
6. See LifecycleEventConfigurationTypeDef
7. See CreateLayerResultTypeDef

# create_layer method usage example with argument unpacking

kwargs: CreateLayerRequestTypeDef = {  # (1)
    "StackId": ...,
    "Type": ...,
    "Name": ...,
    "Shortname": ...,
}

parent.create_layer(**kwargs)

1. See CreateLayerRequestTypeDef

create_stack

Creates a new stack.

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

# create_stack 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

# create_stack method usage example with argument unpacking

kwargs: CreateStackRequestTypeDef = {  # (1)
    "Name": ...,
    "Region": ...,
    "ServiceRoleArn": ...,
    "DefaultInstanceProfileArn": ...,
}

parent.create_stack(**kwargs)

1. See CreateStackRequestTypeDef

create_user_profile

Creates a new user profile.

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

# create_user_profile method definition

def create_user_profile(
    self,
    *,
    IamUserArn: str,
    SshUsername: str = ...,
    SshPublicKey: str = ...,
    AllowSelfManagement: bool = ...,
) -> CreateUserProfileResultTypeDef:  # (1)
    ...

1. See CreateUserProfileResultTypeDef

# create_user_profile method usage example with argument unpacking

kwargs: CreateUserProfileRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.create_user_profile(**kwargs)

1. See CreateUserProfileRequestTypeDef

delete_app

Deletes a specified app.

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

# delete_app method definition

def delete_app(
    self,
    *,
    AppId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_app method usage example with argument unpacking

kwargs: DeleteAppRequestTypeDef = {  # (1)
    "AppId": ...,
}

parent.delete_app(**kwargs)

1. See DeleteAppRequestTypeDef

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

# delete_instance method definition

def delete_instance(
    self,
    *,
    InstanceId: str,
    DeleteElasticIp: bool = ...,
    DeleteVolumes: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_instance method usage example with argument unpacking

kwargs: DeleteInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.delete_instance(**kwargs)

1. See DeleteInstanceRequestTypeDef

delete_layer

Deletes a specified layer.

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

# delete_layer method definition

def delete_layer(
    self,
    *,
    LayerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_layer method usage example with argument unpacking

kwargs: DeleteLayerRequestTypeDef = {  # (1)
    "LayerId": ...,
}

parent.delete_layer(**kwargs)

1. See DeleteLayerRequestTypeDef

delete_stack

Deletes a specified stack.

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

# delete_stack method definition

def delete_stack(
    self,
    *,
    StackId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_stack method usage example with argument unpacking

kwargs: DeleteStackRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.delete_stack(**kwargs)

1. See DeleteStackRequestTypeDef

delete_user_profile

Deletes a user profile.

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

# delete_user_profile method definition

def delete_user_profile(
    self,
    *,
    IamUserArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_user_profile method usage example with argument unpacking

kwargs: DeleteUserProfileRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.delete_user_profile(**kwargs)

1. See DeleteUserProfileRequestTypeDef

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

# deregister_ecs_cluster method definition

def deregister_ecs_cluster(
    self,
    *,
    EcsClusterArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_ecs_cluster method usage example with argument unpacking

kwargs: DeregisterEcsClusterRequestTypeDef = {  # (1)
    "EcsClusterArn": ...,
}

parent.deregister_ecs_cluster(**kwargs)

1. See DeregisterEcsClusterRequestTypeDef

deregister_elastic_ip

Deregisters a specified Elastic IP address.

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

# deregister_elastic_ip method definition

def deregister_elastic_ip(
    self,
    *,
    ElasticIp: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_elastic_ip method usage example with argument unpacking

kwargs: DeregisterElasticIpRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.deregister_elastic_ip(**kwargs)

1. See DeregisterElasticIpRequestTypeDef

deregister_instance

Deregister an instance from OpsWorks Stacks.

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

# deregister_instance method definition

def deregister_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_instance method usage example with argument unpacking

kwargs: DeregisterInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.deregister_instance(**kwargs)

1. See DeregisterInstanceRequestTypeDef

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

# deregister_rds_db_instance method definition

def deregister_rds_db_instance(
    self,
    *,
    RdsDbInstanceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_rds_db_instance method usage example with argument unpacking

kwargs: DeregisterRdsDbInstanceRequestTypeDef = {  # (1)
    "RdsDbInstanceArn": ...,
}

parent.deregister_rds_db_instance(**kwargs)

1. See DeregisterRdsDbInstanceRequestTypeDef

deregister_volume

Deregisters an Amazon EBS volume.

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

# deregister_volume method definition

def deregister_volume(
    self,
    *,
    VolumeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_volume method usage example with argument unpacking

kwargs: DeregisterVolumeRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.deregister_volume(**kwargs)

1. See DeregisterVolumeRequestTypeDef

describe_agent_versions

Describes the available OpsWorks Stacks agent versions.

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

# describe_agent_versions method definition

def describe_agent_versions(
    self,
    *,
    StackId: str = ...,
    ConfigurationManager: StackConfigurationManagerTypeDef = ...,  # (1)
) -> DescribeAgentVersionsResultTypeDef:  # (2)
    ...

1. See StackConfigurationManagerTypeDef
2. See DescribeAgentVersionsResultTypeDef

# describe_agent_versions method usage example with argument unpacking

kwargs: DescribeAgentVersionsRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_agent_versions(**kwargs)

1. See DescribeAgentVersionsRequestTypeDef

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

# describe_apps method definition

def describe_apps(
    self,
    *,
    StackId: str = ...,
    AppIds: Sequence[str] = ...,
) -> DescribeAppsResultTypeDef:  # (1)
    ...

1. See DescribeAppsResultTypeDef

# describe_apps method usage example with argument unpacking

kwargs: DescribeAppsRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_apps(**kwargs)

1. See DescribeAppsRequestTypeDef

describe_commands

Describes the results of specified commands.

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

# describe_commands method definition

def describe_commands(
    self,
    *,
    DeploymentId: str = ...,
    InstanceId: str = ...,
    CommandIds: Sequence[str] = ...,
) -> DescribeCommandsResultTypeDef:  # (1)
    ...

1. See DescribeCommandsResultTypeDef

# describe_commands method usage example with argument unpacking

kwargs: DescribeCommandsRequestTypeDef = {  # (1)
    "DeploymentId": ...,
}

parent.describe_commands(**kwargs)

1. See DescribeCommandsRequestTypeDef

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

# describe_deployments method definition

def describe_deployments(
    self,
    *,
    StackId: str = ...,
    AppId: str = ...,
    DeploymentIds: Sequence[str] = ...,
) -> DescribeDeploymentsResultTypeDef:  # (1)
    ...

1. See DescribeDeploymentsResultTypeDef

# describe_deployments method usage example with argument unpacking

kwargs: DescribeDeploymentsRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_deployments(**kwargs)

1. See DescribeDeploymentsRequestTypeDef

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

# describe_ecs_clusters method definition

def describe_ecs_clusters(
    self,
    *,
    EcsClusterArns: Sequence[str] = ...,
    StackId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeEcsClustersResultTypeDef:  # (1)
    ...

1. See DescribeEcsClustersResultTypeDef

# describe_ecs_clusters method usage example with argument unpacking

kwargs: DescribeEcsClustersRequestTypeDef = {  # (1)
    "EcsClusterArns": ...,
}

parent.describe_ecs_clusters(**kwargs)

1. See DescribeEcsClustersRequestTypeDef

describe_elastic_ips

Describes Elastic IP addresses.

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

# describe_elastic_ips method definition

def describe_elastic_ips(
    self,
    *,
    InstanceId: str = ...,
    StackId: str = ...,
    Ips: Sequence[str] = ...,
) -> DescribeElasticIpsResultTypeDef:  # (1)
    ...

1. See DescribeElasticIpsResultTypeDef

# describe_elastic_ips method usage example with argument unpacking

kwargs: DescribeElasticIpsRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_elastic_ips(**kwargs)

1. See DescribeElasticIpsRequestTypeDef

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

# describe_elastic_load_balancers method definition

def describe_elastic_load_balancers(
    self,
    *,
    StackId: str = ...,
    LayerIds: Sequence[str] = ...,
) -> DescribeElasticLoadBalancersResultTypeDef:  # (1)
    ...

1. See DescribeElasticLoadBalancersResultTypeDef

# describe_elastic_load_balancers method usage example with argument unpacking

kwargs: DescribeElasticLoadBalancersRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_elastic_load_balancers(**kwargs)

1. See DescribeElasticLoadBalancersRequestTypeDef

describe_instances

Requests a description of a set of instances.

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

# describe_instances method definition

def describe_instances(
    self,
    *,
    StackId: str = ...,
    LayerId: str = ...,
    InstanceIds: Sequence[str] = ...,
) -> DescribeInstancesResultTypeDef:  # (1)
    ...

1. See DescribeInstancesResultTypeDef

# describe_instances method usage example with argument unpacking

kwargs: DescribeInstancesRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_instances(**kwargs)

1. See DescribeInstancesRequestTypeDef

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

# describe_layers method definition

def describe_layers(
    self,
    *,
    StackId: str = ...,
    LayerIds: Sequence[str] = ...,
) -> DescribeLayersResultTypeDef:  # (1)
    ...

1. See DescribeLayersResultTypeDef

# describe_layers method usage example with argument unpacking

kwargs: DescribeLayersRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_layers(**kwargs)

1. See DescribeLayersRequestTypeDef

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

# describe_load_based_auto_scaling method definition

def describe_load_based_auto_scaling(
    self,
    *,
    LayerIds: Sequence[str],
) -> DescribeLoadBasedAutoScalingResultTypeDef:  # (1)
    ...

1. See DescribeLoadBasedAutoScalingResultTypeDef

# describe_load_based_auto_scaling method usage example with argument unpacking

kwargs: DescribeLoadBasedAutoScalingRequestTypeDef = {  # (1)
    "LayerIds": ...,
}

parent.describe_load_based_auto_scaling(**kwargs)

1. See DescribeLoadBasedAutoScalingRequestTypeDef

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

# describe_my_user_profile method definition

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

1. See DescribeMyUserProfileResultTypeDef

describe_operating_systems

Describes the operating systems that are supported by OpsWorks Stacks.

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

# describe_operating_systems 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

# describe_permissions method definition

def describe_permissions(
    self,
    *,
    IamUserArn: str = ...,
    StackId: str = ...,
) -> DescribePermissionsResultTypeDef:  # (1)
    ...

1. See DescribePermissionsResultTypeDef

# describe_permissions method usage example with argument unpacking

kwargs: DescribePermissionsRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.describe_permissions(**kwargs)

1. See DescribePermissionsRequestTypeDef

describe_raid_arrays

Describe an instance's RAID arrays.

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

# describe_raid_arrays method definition

def describe_raid_arrays(
    self,
    *,
    InstanceId: str = ...,
    StackId: str = ...,
    RaidArrayIds: Sequence[str] = ...,
) -> DescribeRaidArraysResultTypeDef:  # (1)
    ...

1. See DescribeRaidArraysResultTypeDef

# describe_raid_arrays method usage example with argument unpacking

kwargs: DescribeRaidArraysRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_raid_arrays(**kwargs)

1. See DescribeRaidArraysRequestTypeDef

describe_rds_db_instances

Describes Amazon RDS instances.

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

# describe_rds_db_instances method definition

def describe_rds_db_instances(
    self,
    *,
    StackId: str,
    RdsDbInstanceArns: Sequence[str] = ...,
) -> DescribeRdsDbInstancesResultTypeDef:  # (1)
    ...

1. See DescribeRdsDbInstancesResultTypeDef

# describe_rds_db_instances method usage example with argument unpacking

kwargs: DescribeRdsDbInstancesRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_rds_db_instances(**kwargs)

1. See DescribeRdsDbInstancesRequestTypeDef

describe_service_errors

Describes OpsWorks Stacks service errors.

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

# describe_service_errors method definition

def describe_service_errors(
    self,
    *,
    StackId: str = ...,
    InstanceId: str = ...,
    ServiceErrorIds: Sequence[str] = ...,
) -> DescribeServiceErrorsResultTypeDef:  # (1)
    ...

1. See DescribeServiceErrorsResultTypeDef

# describe_service_errors method usage example with argument unpacking

kwargs: DescribeServiceErrorsRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_service_errors(**kwargs)

1. See DescribeServiceErrorsRequestTypeDef

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

# describe_stack_provisioning_parameters method definition

def describe_stack_provisioning_parameters(
    self,
    *,
    StackId: str,
) -> DescribeStackProvisioningParametersResultTypeDef:  # (1)
    ...

1. See DescribeStackProvisioningParametersResultTypeDef

# describe_stack_provisioning_parameters method usage example with argument unpacking

kwargs: DescribeStackProvisioningParametersRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_stack_provisioning_parameters(**kwargs)

1. See DescribeStackProvisioningParametersRequestTypeDef

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

# describe_stack_summary method definition

def describe_stack_summary(
    self,
    *,
    StackId: str,
) -> DescribeStackSummaryResultTypeDef:  # (1)
    ...

1. See DescribeStackSummaryResultTypeDef

# describe_stack_summary method usage example with argument unpacking

kwargs: DescribeStackSummaryRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.describe_stack_summary(**kwargs)

1. See DescribeStackSummaryRequestTypeDef

describe_stacks

Requests a description of one or more stacks.

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

# describe_stacks method definition

def describe_stacks(
    self,
    *,
    StackIds: Sequence[str] = ...,
) -> DescribeStacksResultTypeDef:  # (1)
    ...

1. See DescribeStacksResultTypeDef

# describe_stacks method usage example with argument unpacking

kwargs: DescribeStacksRequestTypeDef = {  # (1)
    "StackIds": ...,
}

parent.describe_stacks(**kwargs)

1. See DescribeStacksRequestTypeDef

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

# describe_time_based_auto_scaling method definition

def describe_time_based_auto_scaling(
    self,
    *,
    InstanceIds: Sequence[str],
) -> DescribeTimeBasedAutoScalingResultTypeDef:  # (1)
    ...

1. See DescribeTimeBasedAutoScalingResultTypeDef

# describe_time_based_auto_scaling method usage example with argument unpacking

kwargs: DescribeTimeBasedAutoScalingRequestTypeDef = {  # (1)
    "InstanceIds": ...,
}

parent.describe_time_based_auto_scaling(**kwargs)

1. See DescribeTimeBasedAutoScalingRequestTypeDef

describe_user_profiles

Describe specified users.

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

# describe_user_profiles method definition

def describe_user_profiles(
    self,
    *,
    IamUserArns: Sequence[str] = ...,
) -> DescribeUserProfilesResultTypeDef:  # (1)
    ...

1. See DescribeUserProfilesResultTypeDef

# describe_user_profiles method usage example with argument unpacking

kwargs: DescribeUserProfilesRequestTypeDef = {  # (1)
    "IamUserArns": ...,
}

parent.describe_user_profiles(**kwargs)

1. See DescribeUserProfilesRequestTypeDef

describe_volumes

Describes an instance's Amazon EBS volumes.

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

# describe_volumes method definition

def describe_volumes(
    self,
    *,
    InstanceId: str = ...,
    StackId: str = ...,
    RaidArrayId: str = ...,
    VolumeIds: Sequence[str] = ...,
) -> DescribeVolumesResultTypeDef:  # (1)
    ...

1. See DescribeVolumesResultTypeDef

# describe_volumes method usage example with argument unpacking

kwargs: DescribeVolumesRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_volumes(**kwargs)

1. See DescribeVolumesRequestTypeDef

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

# detach_elastic_load_balancer method definition

def detach_elastic_load_balancer(
    self,
    *,
    ElasticLoadBalancerName: str,
    LayerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# detach_elastic_load_balancer method usage example with argument unpacking

kwargs: DetachElasticLoadBalancerRequestTypeDef = {  # (1)
    "ElasticLoadBalancerName": ...,
    "LayerId": ...,
}

parent.detach_elastic_load_balancer(**kwargs)

1. See DetachElasticLoadBalancerRequestTypeDef

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

# disassociate_elastic_ip method definition

def disassociate_elastic_ip(
    self,
    *,
    ElasticIp: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# disassociate_elastic_ip method usage example with argument unpacking

kwargs: DisassociateElasticIpRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.disassociate_elastic_ip(**kwargs)

1. See DisassociateElasticIpRequestTypeDef

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

# get_hostname_suggestion method definition

def get_hostname_suggestion(
    self,
    *,
    LayerId: str,
) -> GetHostnameSuggestionResultTypeDef:  # (1)
    ...

1. See GetHostnameSuggestionResultTypeDef

# get_hostname_suggestion method usage example with argument unpacking

kwargs: GetHostnameSuggestionRequestTypeDef = {  # (1)
    "LayerId": ...,
}

parent.get_hostname_suggestion(**kwargs)

1. See GetHostnameSuggestionRequestTypeDef

grant_access

This action can be used only with Windows stacks.

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

# grant_access method definition

def grant_access(
    self,
    *,
    InstanceId: str,
    ValidForInMinutes: int = ...,
) -> GrantAccessResultTypeDef:  # (1)
    ...

1. See GrantAccessResultTypeDef

# grant_access method usage example with argument unpacking

kwargs: GrantAccessRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.grant_access(**kwargs)

1. See GrantAccessRequestTypeDef

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

# list_tags method definition

def list_tags(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsResultTypeDef:  # (1)
    ...

1. See ListTagsResultTypeDef

# list_tags method usage example with argument unpacking

kwargs: ListTagsRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags(**kwargs)

1. See ListTagsRequestTypeDef

reboot_instance

Reboots a specified instance.

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

# reboot_instance method definition

def reboot_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# reboot_instance method usage example with argument unpacking

kwargs: RebootInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.reboot_instance(**kwargs)

1. See RebootInstanceRequestTypeDef

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

# register_ecs_cluster method definition

def register_ecs_cluster(
    self,
    *,
    EcsClusterArn: str,
    StackId: str,
) -> RegisterEcsClusterResultTypeDef:  # (1)
    ...

1. See RegisterEcsClusterResultTypeDef

# register_ecs_cluster method usage example with argument unpacking

kwargs: RegisterEcsClusterRequestTypeDef = {  # (1)
    "EcsClusterArn": ...,
    "StackId": ...,
}

parent.register_ecs_cluster(**kwargs)

1. See RegisterEcsClusterRequestTypeDef

register_elastic_ip

Registers an Elastic IP address with a specified stack.

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

# register_elastic_ip method definition

def register_elastic_ip(
    self,
    *,
    ElasticIp: str,
    StackId: str,
) -> RegisterElasticIpResultTypeDef:  # (1)
    ...

1. See RegisterElasticIpResultTypeDef

# register_elastic_ip method usage example with argument unpacking

kwargs: RegisterElasticIpRequestTypeDef = {  # (1)
    "ElasticIp": ...,
    "StackId": ...,
}

parent.register_elastic_ip(**kwargs)

1. See RegisterElasticIpRequestTypeDef

register_instance

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

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

# register_instance method definition

def register_instance(
    self,
    *,
    StackId: str,
    Hostname: str = ...,
    PublicIp: str = ...,
    PrivateIp: str = ...,
    RsaPublicKey: str = ...,
    RsaPublicKeyFingerprint: str = ...,
    InstanceIdentity: InstanceIdentityTypeDef = ...,  # (1)
) -> RegisterInstanceResultTypeDef:  # (2)
    ...

1. See InstanceIdentityTypeDef
2. See RegisterInstanceResultTypeDef

# register_instance method usage example with argument unpacking

kwargs: RegisterInstanceRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.register_instance(**kwargs)

1. See RegisterInstanceRequestTypeDef

register_rds_db_instance

Registers an Amazon RDS instance with a stack.

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

# register_rds_db_instance method definition

def register_rds_db_instance(
    self,
    *,
    StackId: str,
    RdsDbInstanceArn: str,
    DbUser: str,
    DbPassword: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# register_rds_db_instance method usage example with argument unpacking

kwargs: RegisterRdsDbInstanceRequestTypeDef = {  # (1)
    "StackId": ...,
    "RdsDbInstanceArn": ...,
    "DbUser": ...,
    "DbPassword": ...,
}

parent.register_rds_db_instance(**kwargs)

1. See RegisterRdsDbInstanceRequestTypeDef

register_volume

Registers an Amazon EBS volume with a specified stack.

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

# register_volume method definition

def register_volume(
    self,
    *,
    StackId: str,
    Ec2VolumeId: str = ...,
) -> RegisterVolumeResultTypeDef:  # (1)
    ...

1. See RegisterVolumeResultTypeDef

# register_volume method usage example with argument unpacking

kwargs: RegisterVolumeRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.register_volume(**kwargs)

1. See RegisterVolumeRequestTypeDef

set_load_based_auto_scaling

Specify the load-based auto scaling configuration for a specified layer.

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

# set_load_based_auto_scaling method definition

def set_load_based_auto_scaling(
    self,
    *,
    LayerId: str,
    Enable: bool = ...,
    UpScaling: AutoScalingThresholdsUnionTypeDef = ...,  # (1)
    DownScaling: AutoScalingThresholdsUnionTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See AutoScalingThresholdsTypeDef AutoScalingThresholdsOutputTypeDef
2. See AutoScalingThresholdsTypeDef AutoScalingThresholdsOutputTypeDef
3. See EmptyResponseMetadataTypeDef

# set_load_based_auto_scaling method usage example with argument unpacking

kwargs: SetLoadBasedAutoScalingRequestTypeDef = {  # (1)
    "LayerId": ...,
}

parent.set_load_based_auto_scaling(**kwargs)

1. See SetLoadBasedAutoScalingRequestTypeDef

set_permission

Specifies a user's permissions.

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

# set_permission method definition

def set_permission(
    self,
    *,
    StackId: str,
    IamUserArn: str,
    AllowSsh: bool = ...,
    AllowSudo: bool = ...,
    Level: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# set_permission method usage example with argument unpacking

kwargs: SetPermissionRequestTypeDef = {  # (1)
    "StackId": ...,
    "IamUserArn": ...,
}

parent.set_permission(**kwargs)

1. See SetPermissionRequestTypeDef

set_time_based_auto_scaling

Specify the time-based auto scaling configuration for a specified instance.

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

# set_time_based_auto_scaling method definition

def set_time_based_auto_scaling(
    self,
    *,
    InstanceId: str,
    AutoScalingSchedule: WeeklyAutoScalingScheduleUnionTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See WeeklyAutoScalingScheduleTypeDef WeeklyAutoScalingScheduleOutputTypeDef
2. See EmptyResponseMetadataTypeDef

# set_time_based_auto_scaling method usage example with argument unpacking

kwargs: SetTimeBasedAutoScalingRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.set_time_based_auto_scaling(**kwargs)

1. See SetTimeBasedAutoScalingRequestTypeDef

start_instance

Starts a specified instance.

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

# start_instance method definition

def start_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_instance method usage example with argument unpacking

kwargs: StartInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.start_instance(**kwargs)

1. See StartInstanceRequestTypeDef

start_stack

Starts a stack's instances.

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

# start_stack method definition

def start_stack(
    self,
    *,
    StackId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_stack method usage example with argument unpacking

kwargs: StartStackRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.start_stack(**kwargs)

1. See StartStackRequestTypeDef

stop_instance

Stops a specified instance.

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

# stop_instance method definition

def stop_instance(
    self,
    *,
    InstanceId: str,
    Force: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_instance method usage example with argument unpacking

kwargs: StopInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.stop_instance(**kwargs)

1. See StopInstanceRequestTypeDef

stop_stack

Stops a specified stack.

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

# stop_stack method definition

def stop_stack(
    self,
    *,
    StackId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_stack method usage example with argument unpacking

kwargs: StopStackRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.stop_stack(**kwargs)

1. See StopStackRequestTypeDef

tag_resource

Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

unassign_instance

Unassigns a registered instance from all layers that are using the instance.

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

# unassign_instance method definition

def unassign_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# unassign_instance method usage example with argument unpacking

kwargs: UnassignInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.unassign_instance(**kwargs)

1. See UnassignInstanceRequestTypeDef

unassign_volume

Unassigns an assigned Amazon EBS volume.

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

# unassign_volume method definition

def unassign_volume(
    self,
    *,
    VolumeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# unassign_volume method usage example with argument unpacking

kwargs: UnassignVolumeRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.unassign_volume(**kwargs)

1. See UnassignVolumeRequestTypeDef

untag_resource

Removes tags from a specified stack or layer.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_app

Updates a specified app.

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

# update_app method definition

def update_app(
    self,
    *,
    AppId: str,
    Name: str = ...,
    Description: str = ...,
    DataSources: Sequence[DataSourceTypeDef] = ...,  # (1)
    Type: AppTypeType = ...,  # (2)
    AppSource: SourceTypeDef = ...,  # (3)
    Domains: Sequence[str] = ...,
    EnableSsl: bool = ...,
    SslConfiguration: SslConfigurationTypeDef = ...,  # (4)
    Attributes: Mapping[AppAttributesKeysType, str] = ...,  # (5)
    Environment: Sequence[EnvironmentVariableTypeDef] = ...,  # (6)
) -> EmptyResponseMetadataTypeDef:  # (7)
    ...

1. See DataSourceTypeDef
2. See AppTypeType
3. See SourceTypeDef
4. See SslConfigurationTypeDef
5. See AppAttributesKeysType
6. See EnvironmentVariableTypeDef
7. See EmptyResponseMetadataTypeDef

# update_app method usage example with argument unpacking

kwargs: UpdateAppRequestTypeDef = {  # (1)
    "AppId": ...,
}

parent.update_app(**kwargs)

1. See UpdateAppRequestTypeDef

update_elastic_ip

Updates a registered Elastic IP address's name.

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

# update_elastic_ip method definition

def update_elastic_ip(
    self,
    *,
    ElasticIp: str,
    Name: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_elastic_ip method usage example with argument unpacking

kwargs: UpdateElasticIpRequestTypeDef = {  # (1)
    "ElasticIp": ...,
}

parent.update_elastic_ip(**kwargs)

1. See UpdateElasticIpRequestTypeDef

update_instance

Updates a specified instance.

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

# update_instance method definition

def update_instance(
    self,
    *,
    InstanceId: str,
    LayerIds: Sequence[str] = ...,
    InstanceType: str = ...,
    AutoScalingType: AutoScalingTypeType = ...,  # (1)
    Hostname: str = ...,
    Os: str = ...,
    AmiId: str = ...,
    SshKeyName: str = ...,
    Architecture: ArchitectureType = ...,  # (2)
    InstallUpdatesOnBoot: bool = ...,
    EbsOptimized: bool = ...,
    AgentVersion: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See AutoScalingTypeType
2. See ArchitectureType
3. See EmptyResponseMetadataTypeDef

# update_instance method usage example with argument unpacking

kwargs: UpdateInstanceRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.update_instance(**kwargs)

1. See UpdateInstanceRequestTypeDef

update_layer

Updates a specified layer.

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

# update_layer method definition

def update_layer(
    self,
    *,
    LayerId: str,
    Name: str = ...,
    Shortname: str = ...,
    Attributes: Mapping[LayerAttributesKeysType, str] = ...,  # (1)
    CloudWatchLogsConfiguration: CloudWatchLogsConfigurationUnionTypeDef = ...,  # (2)
    CustomInstanceProfileArn: str = ...,
    CustomJson: str = ...,
    CustomSecurityGroupIds: Sequence[str] = ...,
    Packages: Sequence[str] = ...,
    VolumeConfigurations: Sequence[VolumeConfigurationTypeDef] = ...,  # (3)
    EnableAutoHealing: bool = ...,
    AutoAssignElasticIps: bool = ...,
    AutoAssignPublicIps: bool = ...,
    CustomRecipes: RecipesUnionTypeDef = ...,  # (4)
    InstallUpdatesOnBoot: bool = ...,
    UseEbsOptimizedInstances: bool = ...,
    LifecycleEventConfiguration: LifecycleEventConfigurationTypeDef = ...,  # (5)
) -> EmptyResponseMetadataTypeDef:  # (6)
    ...

1. See LayerAttributesKeysType
2. See CloudWatchLogsConfigurationTypeDef CloudWatchLogsConfigurationOutputTypeDef
3. See VolumeConfigurationTypeDef
4. See RecipesTypeDef RecipesOutputTypeDef
5. See LifecycleEventConfigurationTypeDef
6. See EmptyResponseMetadataTypeDef

# update_layer method usage example with argument unpacking

kwargs: UpdateLayerRequestTypeDef = {  # (1)
    "LayerId": ...,
}

parent.update_layer(**kwargs)

1. See UpdateLayerRequestTypeDef

update_my_user_profile

Updates a user's SSH public key.

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

# update_my_user_profile method definition

def update_my_user_profile(
    self,
    *,
    SshPublicKey: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_my_user_profile method usage example with argument unpacking

kwargs: UpdateMyUserProfileRequestTypeDef = {  # (1)
    "SshPublicKey": ...,
}

parent.update_my_user_profile(**kwargs)

1. See UpdateMyUserProfileRequestTypeDef

update_rds_db_instance

Updates an Amazon RDS instance.

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

# update_rds_db_instance method definition

def update_rds_db_instance(
    self,
    *,
    RdsDbInstanceArn: str,
    DbUser: str = ...,
    DbPassword: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_rds_db_instance method usage example with argument unpacking

kwargs: UpdateRdsDbInstanceRequestTypeDef = {  # (1)
    "RdsDbInstanceArn": ...,
}

parent.update_rds_db_instance(**kwargs)

1. See UpdateRdsDbInstanceRequestTypeDef

update_stack

Updates a specified stack.

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

# update_stack method definition

def update_stack(
    self,
    *,
    StackId: str,
    Name: str = ...,
    Attributes: Mapping[StackAttributesKeysType, str] = ...,  # (1)
    ServiceRoleArn: str = ...,
    DefaultInstanceProfileArn: str = ...,
    DefaultOs: str = ...,
    HostnameTheme: str = ...,
    DefaultAvailabilityZone: str = ...,
    DefaultSubnetId: str = ...,
    CustomJson: str = ...,
    ConfigurationManager: StackConfigurationManagerTypeDef = ...,  # (2)
    ChefConfiguration: ChefConfigurationTypeDef = ...,  # (3)
    UseCustomCookbooks: bool = ...,
    CustomCookbooksSource: SourceTypeDef = ...,  # (4)
    DefaultSshKeyName: str = ...,
    DefaultRootDeviceType: RootDeviceTypeType = ...,  # (5)
    UseOpsworksSecurityGroups: bool = ...,
    AgentVersion: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (6)
    ...

1. See StackAttributesKeysType
2. See StackConfigurationManagerTypeDef
3. See ChefConfigurationTypeDef
4. See SourceTypeDef
5. See RootDeviceTypeType
6. See EmptyResponseMetadataTypeDef

# update_stack method usage example with argument unpacking

kwargs: UpdateStackRequestTypeDef = {  # (1)
    "StackId": ...,
}

parent.update_stack(**kwargs)

1. See UpdateStackRequestTypeDef

update_user_profile

Updates a specified user profile.

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

# update_user_profile method definition

def update_user_profile(
    self,
    *,
    IamUserArn: str,
    SshUsername: str = ...,
    SshPublicKey: str = ...,
    AllowSelfManagement: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_user_profile method usage example with argument unpacking

kwargs: UpdateUserProfileRequestTypeDef = {  # (1)
    "IamUserArn": ...,
}

parent.update_user_profile(**kwargs)

1. See UpdateUserProfileRequestTypeDef

update_volume

Updates an Amazon EBS volume's name or mount point.

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

# update_volume method definition

def update_volume(
    self,
    *,
    VolumeId: str,
    Name: str = ...,
    MountPoint: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_volume method usage example with argument unpacking

kwargs: UpdateVolumeRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.update_volume(**kwargs)

1. See UpdateVolumeRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("opsworks").get_paginator method with overloads.

• client.get_paginator("describe_ecs_clusters") -> DescribeEcsClustersPaginator

get_waiter

Type annotations and code completion for boto3.client("opsworks").get_waiter method with overloads.

• client.get_waiter("app_exists") -> AppExistsWaiter
• client.get_waiter("deployment_successful") -> DeploymentSuccessfulWaiter
• client.get_waiter("instance_online") -> InstanceOnlineWaiter
• client.get_waiter("instance_registered") -> InstanceRegisteredWaiter
• client.get_waiter("instance_stopped") -> InstanceStoppedWaiter
• client.get_waiter("instance_terminated") -> InstanceTerminatedWaiter