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
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.
client = boto3.client("opsworks")
try:
do_something(client)
except (
client.ClientError,
client.ResourceNotFoundException,
client.ValidationException,
) as e:
print(e)
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
def assign_instance(
self,
*,
InstanceId: str,
LayerIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssignInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LayerIds": ...,
}
parent.assign_instance(**kwargs)
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
def assign_volume(
self,
*,
VolumeId: str,
InstanceId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssignVolumeRequestRequestTypeDef = { # (1)
"VolumeId": ...,
}
parent.assign_volume(**kwargs)
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
def associate_elastic_ip(
self,
*,
ElasticIp: str,
InstanceId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssociateElasticIpRequestRequestTypeDef = { # (1)
"ElasticIp": ...,
}
parent.associate_elastic_ip(**kwargs)
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
def attach_elastic_load_balancer(
self,
*,
ElasticLoadBalancerName: str,
LayerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AttachElasticLoadBalancerRequestRequestTypeDef = { # (1)
"ElasticLoadBalancerName": ...,
"LayerId": ...,
}
parent.attach_elastic_load_balancer(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("opsworks").can_paginate
method.
boto3 documentation
clone_stack
Creates a clone of a specified stack.
Type annotations and code completion for boto3.client("opsworks").clone_stack
method.
boto3 documentation
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)
...
- See StackAttributesKeysType
- See StackConfigurationManagerTypeDef
- See ChefConfigurationTypeDef
- See SourceTypeDef
- See RootDeviceTypeType
- See CloneStackResultTypeDef
kwargs: CloneStackRequestRequestTypeDef = { # (1)
"SourceStackId": ...,
"ServiceRoleArn": ...,
}
parent.clone_stack(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("opsworks").close
method.
boto3 documentation
create_app
Creates an app for a specified stack.
Type annotations and code completion for boto3.client("opsworks").create_app
method.
boto3 documentation
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)
...
- See AppTypeType
- See DataSourceTypeDef
- See SourceTypeDef
- See SslConfigurationTypeDef
- See AppAttributesKeysType
- See EnvironmentVariableTypeDef
- See CreateAppResultTypeDef
kwargs: CreateAppRequestRequestTypeDef = { # (1)
"StackId": ...,
"Name": ...,
"Type": ...,
}
parent.create_app(**kwargs)
create_deployment
Runs deployment or stack commands.
Type annotations and code completion for boto3.client("opsworks").create_deployment
method.
boto3 documentation
def create_deployment(
self,
*,
StackId: str,
Command: DeploymentCommandTypeDef, # (1)
AppId: str = ...,
InstanceIds: Sequence[str] = ...,
LayerIds: Sequence[str] = ...,
Comment: str = ...,
CustomJson: str = ...,
) -> CreateDeploymentResultTypeDef: # (2)
...
kwargs: CreateDeploymentRequestRequestTypeDef = { # (1)
"StackId": ...,
"Command": ...,
}
parent.create_deployment(**kwargs)
create_instance
Creates an instance in a specified stack.
Type annotations and code completion for boto3.client("opsworks").create_instance
method.
boto3 documentation
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)
...
- See AutoScalingTypeType
- See ArchitectureType
- See RootDeviceTypeType
- See BlockDeviceMappingTypeDef
- See CreateInstanceResultTypeDef
kwargs: CreateInstanceRequestRequestTypeDef = { # (1)
"StackId": ...,
"LayerIds": ...,
"InstanceType": ...,
}
parent.create_instance(**kwargs)
create_layer
Creates a layer.
Type annotations and code completion for boto3.client("opsworks").create_layer
method.
boto3 documentation
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)
...
- See LayerTypeType
- See LayerAttributesKeysType
- See CloudWatchLogsConfigurationTypeDef
- See VolumeConfigurationTypeDef
- See RecipesTypeDef
- See LifecycleEventConfigurationTypeDef
- See CreateLayerResultTypeDef
kwargs: CreateLayerRequestRequestTypeDef = { # (1)
"StackId": ...,
"Type": ...,
"Name": ...,
"Shortname": ...,
}
parent.create_layer(**kwargs)
create_stack
Creates a new stack.
Type annotations and code completion for boto3.client("opsworks").create_stack
method.
boto3 documentation
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)
...
- See StackAttributesKeysType
- See StackConfigurationManagerTypeDef
- See ChefConfigurationTypeDef
- See SourceTypeDef
- See RootDeviceTypeType
- See CreateStackResultTypeDef
kwargs: CreateStackRequestRequestTypeDef = { # (1)
"Name": ...,
"Region": ...,
"ServiceRoleArn": ...,
"DefaultInstanceProfileArn": ...,
}
parent.create_stack(**kwargs)
create_user_profile
Creates a new user profile.
Type annotations and code completion for boto3.client("opsworks").create_user_profile
method.
boto3 documentation
def create_user_profile(
self,
*,
IamUserArn: str,
SshUsername: str = ...,
SshPublicKey: str = ...,
AllowSelfManagement: bool = ...,
) -> CreateUserProfileResultTypeDef: # (1)
...
kwargs: CreateUserProfileRequestRequestTypeDef = { # (1)
"IamUserArn": ...,
}
parent.create_user_profile(**kwargs)
delete_app
Deletes a specified app.
Type annotations and code completion for boto3.client("opsworks").delete_app
method.
boto3 documentation
kwargs: DeleteAppRequestRequestTypeDef = { # (1)
"AppId": ...,
}
parent.delete_app(**kwargs)
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
def delete_instance(
self,
*,
InstanceId: str,
DeleteElasticIp: bool = ...,
DeleteVolumes: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.delete_instance(**kwargs)
delete_layer
Deletes a specified layer.
Type annotations and code completion for boto3.client("opsworks").delete_layer
method.
boto3 documentation
def delete_layer(
self,
*,
LayerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteLayerRequestRequestTypeDef = { # (1)
"LayerId": ...,
}
parent.delete_layer(**kwargs)
delete_stack
Deletes a specified stack.
Type annotations and code completion for boto3.client("opsworks").delete_stack
method.
boto3 documentation
def delete_stack(
self,
*,
StackId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteStackRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.delete_stack(**kwargs)
delete_user_profile
Deletes a user profile.
Type annotations and code completion for boto3.client("opsworks").delete_user_profile
method.
boto3 documentation
def delete_user_profile(
self,
*,
IamUserArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserProfileRequestRequestTypeDef = { # (1)
"IamUserArn": ...,
}
parent.delete_user_profile(**kwargs)
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
def deregister_ecs_cluster(
self,
*,
EcsClusterArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterEcsClusterRequestRequestTypeDef = { # (1)
"EcsClusterArn": ...,
}
parent.deregister_ecs_cluster(**kwargs)
deregister_elastic_ip
Deregisters a specified Elastic IP address.
Type annotations and code completion for boto3.client("opsworks").deregister_elastic_ip
method.
boto3 documentation
def deregister_elastic_ip(
self,
*,
ElasticIp: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterElasticIpRequestRequestTypeDef = { # (1)
"ElasticIp": ...,
}
parent.deregister_elastic_ip(**kwargs)
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
def deregister_instance(
self,
*,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.deregister_instance(**kwargs)
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
def deregister_rds_db_instance(
self,
*,
RdsDbInstanceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterRdsDbInstanceRequestRequestTypeDef = { # (1)
"RdsDbInstanceArn": ...,
}
parent.deregister_rds_db_instance(**kwargs)
deregister_volume
Deregisters an Amazon EBS volume.
Type annotations and code completion for boto3.client("opsworks").deregister_volume
method.
boto3 documentation
def deregister_volume(
self,
*,
VolumeId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterVolumeRequestRequestTypeDef = { # (1)
"VolumeId": ...,
}
parent.deregister_volume(**kwargs)
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
def describe_agent_versions(
self,
*,
StackId: str = ...,
ConfigurationManager: StackConfigurationManagerTypeDef = ..., # (1)
) -> DescribeAgentVersionsResultTypeDef: # (2)
...
kwargs: DescribeAgentVersionsRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_agent_versions(**kwargs)
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
def describe_apps(
self,
*,
StackId: str = ...,
AppIds: Sequence[str] = ...,
) -> DescribeAppsResultTypeDef: # (1)
...
kwargs: DescribeAppsRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_apps(**kwargs)
describe_commands
Describes the results of specified commands.
Type annotations and code completion for boto3.client("opsworks").describe_commands
method.
boto3 documentation
def describe_commands(
self,
*,
DeploymentId: str = ...,
InstanceId: str = ...,
CommandIds: Sequence[str] = ...,
) -> DescribeCommandsResultTypeDef: # (1)
...
kwargs: DescribeCommandsRequestRequestTypeDef = { # (1)
"DeploymentId": ...,
}
parent.describe_commands(**kwargs)
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
def describe_deployments(
self,
*,
StackId: str = ...,
AppId: str = ...,
DeploymentIds: Sequence[str] = ...,
) -> DescribeDeploymentsResultTypeDef: # (1)
...
kwargs: DescribeDeploymentsRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_deployments(**kwargs)
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
def describe_ecs_clusters(
self,
*,
EcsClusterArns: Sequence[str] = ...,
StackId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeEcsClustersResultTypeDef: # (1)
...
kwargs: DescribeEcsClustersRequestRequestTypeDef = { # (1)
"EcsClusterArns": ...,
}
parent.describe_ecs_clusters(**kwargs)
describe_elastic_ips
Describes Elastic IP addresses_.
Type annotations and code completion for boto3.client("opsworks").describe_elastic_ips
method.
boto3 documentation
def describe_elastic_ips(
self,
*,
InstanceId: str = ...,
StackId: str = ...,
Ips: Sequence[str] = ...,
) -> DescribeElasticIpsResultTypeDef: # (1)
...
kwargs: DescribeElasticIpsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_elastic_ips(**kwargs)
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
def describe_elastic_load_balancers(
self,
*,
StackId: str = ...,
LayerIds: Sequence[str] = ...,
) -> DescribeElasticLoadBalancersResultTypeDef: # (1)
...
kwargs: DescribeElasticLoadBalancersRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_elastic_load_balancers(**kwargs)
describe_instances
Requests a description of a set of instances.
Type annotations and code completion for boto3.client("opsworks").describe_instances
method.
boto3 documentation
def describe_instances(
self,
*,
StackId: str = ...,
LayerId: str = ...,
InstanceIds: Sequence[str] = ...,
) -> DescribeInstancesResultTypeDef: # (1)
...
kwargs: DescribeInstancesRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_instances(**kwargs)
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
def describe_layers(
self,
*,
StackId: str = ...,
LayerIds: Sequence[str] = ...,
) -> DescribeLayersResultTypeDef: # (1)
...
kwargs: DescribeLayersRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_layers(**kwargs)
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
def describe_load_based_auto_scaling(
self,
*,
LayerIds: Sequence[str],
) -> DescribeLoadBasedAutoScalingResultTypeDef: # (1)
...
kwargs: DescribeLoadBasedAutoScalingRequestRequestTypeDef = { # (1)
"LayerIds": ...,
}
parent.describe_load_based_auto_scaling(**kwargs)
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
def describe_my_user_profile(
self,
) -> DescribeMyUserProfileResultTypeDef: # (1)
...
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
def describe_operating_systems(
self,
) -> DescribeOperatingSystemsResponseTypeDef: # (1)
...
describe_permissions
Describes the permissions for a specified stack.
Type annotations and code completion for boto3.client("opsworks").describe_permissions
method.
boto3 documentation
def describe_permissions(
self,
*,
IamUserArn: str = ...,
StackId: str = ...,
) -> DescribePermissionsResultTypeDef: # (1)
...
kwargs: DescribePermissionsRequestRequestTypeDef = { # (1)
"IamUserArn": ...,
}
parent.describe_permissions(**kwargs)
describe_raid_arrays
Describe an instance's RAID arrays.
Type annotations and code completion for boto3.client("opsworks").describe_raid_arrays
method.
boto3 documentation
def describe_raid_arrays(
self,
*,
InstanceId: str = ...,
StackId: str = ...,
RaidArrayIds: Sequence[str] = ...,
) -> DescribeRaidArraysResultTypeDef: # (1)
...
kwargs: DescribeRaidArraysRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_raid_arrays(**kwargs)
describe_rds_db_instances
Describes Amazon RDS instances.
Type annotations and code completion for boto3.client("opsworks").describe_rds_db_instances
method.
boto3 documentation
def describe_rds_db_instances(
self,
*,
StackId: str,
RdsDbInstanceArns: Sequence[str] = ...,
) -> DescribeRdsDbInstancesResultTypeDef: # (1)
...
kwargs: DescribeRdsDbInstancesRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_rds_db_instances(**kwargs)
describe_service_errors
Describes AWS OpsWorks Stacks service errors.
Type annotations and code completion for boto3.client("opsworks").describe_service_errors
method.
boto3 documentation
def describe_service_errors(
self,
*,
StackId: str = ...,
InstanceId: str = ...,
ServiceErrorIds: Sequence[str] = ...,
) -> DescribeServiceErrorsResultTypeDef: # (1)
...
kwargs: DescribeServiceErrorsRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_service_errors(**kwargs)
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
def describe_stack_provisioning_parameters(
self,
*,
StackId: str,
) -> DescribeStackProvisioningParametersResultTypeDef: # (1)
...
kwargs: DescribeStackProvisioningParametersRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_stack_provisioning_parameters(**kwargs)
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
def describe_stack_summary(
self,
*,
StackId: str,
) -> DescribeStackSummaryResultTypeDef: # (1)
...
kwargs: DescribeStackSummaryRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.describe_stack_summary(**kwargs)
describe_stacks
Requests a description of one or more stacks.
Type annotations and code completion for boto3.client("opsworks").describe_stacks
method.
boto3 documentation
def describe_stacks(
self,
*,
StackIds: Sequence[str] = ...,
) -> DescribeStacksResultTypeDef: # (1)
...
kwargs: DescribeStacksRequestRequestTypeDef = { # (1)
"StackIds": ...,
}
parent.describe_stacks(**kwargs)
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
def describe_time_based_auto_scaling(
self,
*,
InstanceIds: Sequence[str],
) -> DescribeTimeBasedAutoScalingResultTypeDef: # (1)
...
kwargs: DescribeTimeBasedAutoScalingRequestRequestTypeDef = { # (1)
"InstanceIds": ...,
}
parent.describe_time_based_auto_scaling(**kwargs)
describe_user_profiles
Describe specified users.
Type annotations and code completion for boto3.client("opsworks").describe_user_profiles
method.
boto3 documentation
def describe_user_profiles(
self,
*,
IamUserArns: Sequence[str] = ...,
) -> DescribeUserProfilesResultTypeDef: # (1)
...
kwargs: DescribeUserProfilesRequestRequestTypeDef = { # (1)
"IamUserArns": ...,
}
parent.describe_user_profiles(**kwargs)
describe_volumes
Describes an instance's Amazon EBS volumes.
Type annotations and code completion for boto3.client("opsworks").describe_volumes
method.
boto3 documentation
def describe_volumes(
self,
*,
InstanceId: str = ...,
StackId: str = ...,
RaidArrayId: str = ...,
VolumeIds: Sequence[str] = ...,
) -> DescribeVolumesResultTypeDef: # (1)
...
kwargs: DescribeVolumesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_volumes(**kwargs)
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
def detach_elastic_load_balancer(
self,
*,
ElasticLoadBalancerName: str,
LayerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DetachElasticLoadBalancerRequestRequestTypeDef = { # (1)
"ElasticLoadBalancerName": ...,
"LayerId": ...,
}
parent.detach_elastic_load_balancer(**kwargs)
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
def disassociate_elastic_ip(
self,
*,
ElasticIp: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateElasticIpRequestRequestTypeDef = { # (1)
"ElasticIp": ...,
}
parent.disassociate_elastic_ip(**kwargs)
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
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
def get_hostname_suggestion(
self,
*,
LayerId: str,
) -> GetHostnameSuggestionResultTypeDef: # (1)
...
kwargs: GetHostnameSuggestionRequestRequestTypeDef = { # (1)
"LayerId": ...,
}
parent.get_hostname_suggestion(**kwargs)
grant_access
.
Type annotations and code completion for boto3.client("opsworks").grant_access
method.
boto3 documentation
def grant_access(
self,
*,
InstanceId: str,
ValidForInMinutes: int = ...,
) -> GrantAccessResultTypeDef: # (1)
...
kwargs: GrantAccessRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.grant_access(**kwargs)
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
def list_tags(
self,
*,
ResourceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTagsResultTypeDef: # (1)
...
kwargs: ListTagsRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags(**kwargs)
reboot_instance
Reboots a specified instance.
Type annotations and code completion for boto3.client("opsworks").reboot_instance
method.
boto3 documentation
def reboot_instance(
self,
*,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RebootInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.reboot_instance(**kwargs)
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
def register_ecs_cluster(
self,
*,
EcsClusterArn: str,
StackId: str,
) -> RegisterEcsClusterResultTypeDef: # (1)
...
kwargs: RegisterEcsClusterRequestRequestTypeDef = { # (1)
"EcsClusterArn": ...,
"StackId": ...,
}
parent.register_ecs_cluster(**kwargs)
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
def register_elastic_ip(
self,
*,
ElasticIp: str,
StackId: str,
) -> RegisterElasticIpResultTypeDef: # (1)
...
kwargs: RegisterElasticIpRequestRequestTypeDef = { # (1)
"ElasticIp": ...,
"StackId": ...,
}
parent.register_elastic_ip(**kwargs)
register_instance
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
Type annotations and code completion for boto3.client("opsworks").register_instance
method.
boto3 documentation
def register_instance(
self,
*,
StackId: str,
Hostname: str = ...,
PublicIp: str = ...,
PrivateIp: str = ...,
RsaPublicKey: str = ...,
RsaPublicKeyFingerprint: str = ...,
InstanceIdentity: InstanceIdentityTypeDef = ..., # (1)
) -> RegisterInstanceResultTypeDef: # (2)
...
kwargs: RegisterInstanceRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.register_instance(**kwargs)
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
def register_rds_db_instance(
self,
*,
StackId: str,
RdsDbInstanceArn: str,
DbUser: str,
DbPassword: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RegisterRdsDbInstanceRequestRequestTypeDef = { # (1)
"StackId": ...,
"RdsDbInstanceArn": ...,
"DbUser": ...,
"DbPassword": ...,
}
parent.register_rds_db_instance(**kwargs)
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
def register_volume(
self,
*,
StackId: str,
Ec2VolumeId: str = ...,
) -> RegisterVolumeResultTypeDef: # (1)
...
kwargs: RegisterVolumeRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.register_volume(**kwargs)
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
def set_load_based_auto_scaling(
self,
*,
LayerId: str,
Enable: bool = ...,
UpScaling: AutoScalingThresholdsTypeDef = ..., # (1)
DownScaling: AutoScalingThresholdsTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (3)
...
kwargs: SetLoadBasedAutoScalingRequestRequestTypeDef = { # (1)
"LayerId": ...,
}
parent.set_load_based_auto_scaling(**kwargs)
set_permission
Specifies a user's permissions.
Type annotations and code completion for boto3.client("opsworks").set_permission
method.
boto3 documentation
def set_permission(
self,
*,
StackId: str,
IamUserArn: str,
AllowSsh: bool = ...,
AllowSudo: bool = ...,
Level: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: SetPermissionRequestRequestTypeDef = { # (1)
"StackId": ...,
"IamUserArn": ...,
}
parent.set_permission(**kwargs)
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
def set_time_based_auto_scaling(
self,
*,
InstanceId: str,
AutoScalingSchedule: WeeklyAutoScalingScheduleTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: SetTimeBasedAutoScalingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.set_time_based_auto_scaling(**kwargs)
start_instance
Starts a specified instance.
Type annotations and code completion for boto3.client("opsworks").start_instance
method.
boto3 documentation
def start_instance(
self,
*,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StartInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.start_instance(**kwargs)
start_stack
Starts a stack's instances.
Type annotations and code completion for boto3.client("opsworks").start_stack
method.
boto3 documentation
def start_stack(
self,
*,
StackId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StartStackRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.start_stack(**kwargs)
stop_instance
Stops a specified instance.
Type annotations and code completion for boto3.client("opsworks").stop_instance
method.
boto3 documentation
def stop_instance(
self,
*,
InstanceId: str,
Force: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.stop_instance(**kwargs)
stop_stack
Stops a specified stack.
Type annotations and code completion for boto3.client("opsworks").stop_stack
method.
boto3 documentation
def stop_stack(
self,
*,
StackId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopStackRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.stop_stack(**kwargs)
tag_resource
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
Type annotations and code completion for boto3.client("opsworks").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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
def unassign_instance(
self,
*,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UnassignInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.unassign_instance(**kwargs)
unassign_volume
Unassigns an assigned Amazon EBS volume.
Type annotations and code completion for boto3.client("opsworks").unassign_volume
method.
boto3 documentation
def unassign_volume(
self,
*,
VolumeId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UnassignVolumeRequestRequestTypeDef = { # (1)
"VolumeId": ...,
}
parent.unassign_volume(**kwargs)
untag_resource
Removes tags from a specified stack or layer.
Type annotations and code completion for boto3.client("opsworks").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_app
Updates a specified app.
Type annotations and code completion for boto3.client("opsworks").update_app
method.
boto3 documentation
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)
...
- See DataSourceTypeDef
- See AppTypeType
- See SourceTypeDef
- See SslConfigurationTypeDef
- See AppAttributesKeysType
- See EnvironmentVariableTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: UpdateAppRequestRequestTypeDef = { # (1)
"AppId": ...,
}
parent.update_app(**kwargs)
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
def update_elastic_ip(
self,
*,
ElasticIp: str,
Name: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateElasticIpRequestRequestTypeDef = { # (1)
"ElasticIp": ...,
}
parent.update_elastic_ip(**kwargs)
update_instance
Updates a specified instance.
Type annotations and code completion for boto3.client("opsworks").update_instance
method.
boto3 documentation
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)
...
kwargs: UpdateInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.update_instance(**kwargs)
update_layer
Updates a specified layer.
Type annotations and code completion for boto3.client("opsworks").update_layer
method.
boto3 documentation
def update_layer(
self,
*,
LayerId: str,
Name: str = ...,
Shortname: str = ...,
Attributes: Mapping[LayerAttributesKeysType, str] = ..., # (1)
CloudWatchLogsConfiguration: CloudWatchLogsConfigurationTypeDef = ..., # (2)
CustomInstanceProfileArn: str = ...,
CustomJson: str = ...,
CustomSecurityGroupIds: Sequence[str] = ...,
Packages: Sequence[str] = ...,
VolumeConfigurations: Sequence[VolumeConfigurationTypeDef] = ..., # (3)
EnableAutoHealing: bool = ...,
AutoAssignElasticIps: bool = ...,
AutoAssignPublicIps: bool = ...,
CustomRecipes: RecipesTypeDef = ..., # (4)
InstallUpdatesOnBoot: bool = ...,
UseEbsOptimizedInstances: bool = ...,
LifecycleEventConfiguration: LifecycleEventConfigurationTypeDef = ..., # (5)
) -> EmptyResponseMetadataTypeDef: # (6)
...
- See LayerAttributesKeysType
- See CloudWatchLogsConfigurationTypeDef
- See VolumeConfigurationTypeDef
- See RecipesTypeDef
- See LifecycleEventConfigurationTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: UpdateLayerRequestRequestTypeDef = { # (1)
"LayerId": ...,
}
parent.update_layer(**kwargs)
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
def update_my_user_profile(
self,
*,
SshPublicKey: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateMyUserProfileRequestRequestTypeDef = { # (1)
"SshPublicKey": ...,
}
parent.update_my_user_profile(**kwargs)
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
def update_rds_db_instance(
self,
*,
RdsDbInstanceArn: str,
DbUser: str = ...,
DbPassword: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateRdsDbInstanceRequestRequestTypeDef = { # (1)
"RdsDbInstanceArn": ...,
}
parent.update_rds_db_instance(**kwargs)
update_stack
Updates a specified stack.
Type annotations and code completion for boto3.client("opsworks").update_stack
method.
boto3 documentation
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)
...
- See StackAttributesKeysType
- See StackConfigurationManagerTypeDef
- See ChefConfigurationTypeDef
- See SourceTypeDef
- See RootDeviceTypeType
- See EmptyResponseMetadataTypeDef
kwargs: UpdateStackRequestRequestTypeDef = { # (1)
"StackId": ...,
}
parent.update_stack(**kwargs)
update_user_profile
Updates a specified user profile.
Type annotations and code completion for boto3.client("opsworks").update_user_profile
method.
boto3 documentation
def update_user_profile(
self,
*,
IamUserArn: str,
SshUsername: str = ...,
SshPublicKey: str = ...,
AllowSelfManagement: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateUserProfileRequestRequestTypeDef = { # (1)
"IamUserArn": ...,
}
parent.update_user_profile(**kwargs)
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
def update_volume(
self,
*,
VolumeId: str,
Name: str = ...,
MountPoint: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateVolumeRequestRequestTypeDef = { # (1)
"VolumeId": ...,
}
parent.update_volume(**kwargs)
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")
-> AppExistsWaiterclient.get_waiter("deployment_successful")
-> DeploymentSuccessfulWaiterclient.get_waiter("instance_online")
-> InstanceOnlineWaiterclient.get_waiter("instance_registered")
-> InstanceRegisteredWaiterclient.get_waiter("instance_stopped")
-> InstanceStoppedWaiterclient.get_waiter("instance_terminated")
-> InstanceTerminatedWaiter