AppConfigClient#
Auto-generated documentation for AppConfig type annotations stubs module mypy-boto3-appconfig.
AppConfigClient#
Type annotations and code completion for boto3.client("appconfig")
.
boto3 documentation
# AppConfigClient usage example
from boto3.session import Session
from mypy_boto3_appconfig.client import AppConfigClient
def get_appconfig_client() -> AppConfigClient:
return Session().client("appconfig")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("appconfig").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("appconfig")
try:
do_something(client)
except (
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.PayloadTooLargeException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_appconfig.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("appconfig").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("appconfig").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_application#
Creates an application.
Type annotations and code completion for boto3.client("appconfig").create_application
method.
boto3 documentation
# create_application method definition
def create_application(
self,
*,
Name: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> ApplicationResponseTypeDef: # (1)
...
# create_application method usage example with argument unpacking
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_application(**kwargs)
create_configuration_profile#
Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
Type annotations and code completion for boto3.client("appconfig").create_configuration_profile
method.
boto3 documentation
# create_configuration_profile method definition
def create_configuration_profile(
self,
*,
ApplicationId: str,
Name: str,
LocationUri: str,
Description: str = ...,
RetrievalRoleArn: str = ...,
Validators: Sequence[ValidatorTypeDef] = ..., # (1)
Tags: Mapping[str, str] = ...,
Type: str = ...,
) -> ConfigurationProfileTypeDef: # (2)
...
# create_configuration_profile method usage example with argument unpacking
kwargs: CreateConfigurationProfileRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"Name": ...,
"LocationUri": ...,
}
parent.create_configuration_profile(**kwargs)
create_deployment_strategy#
Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
Type annotations and code completion for boto3.client("appconfig").create_deployment_strategy
method.
boto3 documentation
# create_deployment_strategy method definition
def create_deployment_strategy(
self,
*,
Name: str,
DeploymentDurationInMinutes: int,
GrowthFactor: float,
Description: str = ...,
FinalBakeTimeInMinutes: int = ...,
GrowthType: GrowthTypeType = ..., # (1)
ReplicateTo: ReplicateToType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> DeploymentStrategyResponseTypeDef: # (3)
...
# create_deployment_strategy method usage example with argument unpacking
kwargs: CreateDeploymentStrategyRequestRequestTypeDef = { # (1)
"Name": ...,
"DeploymentDurationInMinutes": ...,
"GrowthFactor": ...,
}
parent.create_deployment_strategy(**kwargs)
create_environment#
Creates an environment.
Type annotations and code completion for boto3.client("appconfig").create_environment
method.
boto3 documentation
# create_environment method definition
def create_environment(
self,
*,
ApplicationId: str,
Name: str,
Description: str = ...,
Monitors: Sequence[MonitorTypeDef] = ..., # (1)
Tags: Mapping[str, str] = ...,
) -> EnvironmentResponseTypeDef: # (2)
...
# create_environment method usage example with argument unpacking
kwargs: CreateEnvironmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"Name": ...,
}
parent.create_environment(**kwargs)
create_extension#
Creates an AppConfig extension.
Type annotations and code completion for boto3.client("appconfig").create_extension
method.
boto3 documentation
# create_extension method definition
def create_extension(
self,
*,
Name: str,
Actions: Mapping[ActionPointType, Sequence[ActionTypeDef]], # (1)
Description: str = ...,
Parameters: Mapping[str, ParameterTypeDef] = ..., # (2)
Tags: Mapping[str, str] = ...,
LatestVersionNumber: int = ...,
) -> ExtensionTypeDef: # (3)
...
- See ActionPointType ActionTypeDef
- See ParameterTypeDef
- See ExtensionTypeDef
# create_extension method usage example with argument unpacking
kwargs: CreateExtensionRequestRequestTypeDef = { # (1)
"Name": ...,
"Actions": ...,
}
parent.create_extension(**kwargs)
create_extension_association#
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile.
Type annotations and code completion for boto3.client("appconfig").create_extension_association
method.
boto3 documentation
# create_extension_association method definition
def create_extension_association(
self,
*,
ExtensionIdentifier: str,
ResourceIdentifier: str,
ExtensionVersionNumber: int = ...,
Parameters: Mapping[str, str] = ...,
Tags: Mapping[str, str] = ...,
) -> ExtensionAssociationTypeDef: # (1)
...
# create_extension_association method usage example with argument unpacking
kwargs: CreateExtensionAssociationRequestRequestTypeDef = { # (1)
"ExtensionIdentifier": ...,
"ResourceIdentifier": ...,
}
parent.create_extension_association(**kwargs)
create_hosted_configuration_version#
Creates a new configuration in the AppConfig hosted configuration store.
Type annotations and code completion for boto3.client("appconfig").create_hosted_configuration_version
method.
boto3 documentation
# create_hosted_configuration_version method definition
def create_hosted_configuration_version(
self,
*,
ApplicationId: str,
ConfigurationProfileId: str,
Content: Union[str, bytes, IO[Any], StreamingBody],
ContentType: str,
Description: str = ...,
LatestVersionNumber: int = ...,
VersionLabel: str = ...,
) -> HostedConfigurationVersionTypeDef: # (1)
...
# create_hosted_configuration_version method usage example with argument unpacking
kwargs: CreateHostedConfigurationVersionRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ConfigurationProfileId": ...,
"Content": ...,
"ContentType": ...,
}
parent.create_hosted_configuration_version(**kwargs)
delete_application#
Deletes an application.
Type annotations and code completion for boto3.client("appconfig").delete_application
method.
boto3 documentation
# delete_application method definition
def delete_application(
self,
*,
ApplicationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_application method usage example with argument unpacking
kwargs: DeleteApplicationRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_application(**kwargs)
delete_configuration_profile#
Deletes a configuration profile.
Type annotations and code completion for boto3.client("appconfig").delete_configuration_profile
method.
boto3 documentation
# delete_configuration_profile method definition
def delete_configuration_profile(
self,
*,
ApplicationId: str,
ConfigurationProfileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_configuration_profile method usage example with argument unpacking
kwargs: DeleteConfigurationProfileRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ConfigurationProfileId": ...,
}
parent.delete_configuration_profile(**kwargs)
delete_deployment_strategy#
Deletes a deployment strategy.
Type annotations and code completion for boto3.client("appconfig").delete_deployment_strategy
method.
boto3 documentation
# delete_deployment_strategy method definition
def delete_deployment_strategy(
self,
*,
DeploymentStrategyId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_deployment_strategy method usage example with argument unpacking
kwargs: DeleteDeploymentStrategyRequestRequestTypeDef = { # (1)
"DeploymentStrategyId": ...,
}
parent.delete_deployment_strategy(**kwargs)
delete_environment#
Deletes an environment.
Type annotations and code completion for boto3.client("appconfig").delete_environment
method.
boto3 documentation
# delete_environment method definition
def delete_environment(
self,
*,
ApplicationId: str,
EnvironmentId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_environment method usage example with argument unpacking
kwargs: DeleteEnvironmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EnvironmentId": ...,
}
parent.delete_environment(**kwargs)
delete_extension#
Deletes an AppConfig extension.
Type annotations and code completion for boto3.client("appconfig").delete_extension
method.
boto3 documentation
# delete_extension method definition
def delete_extension(
self,
*,
ExtensionIdentifier: str,
VersionNumber: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_extension method usage example with argument unpacking
kwargs: DeleteExtensionRequestRequestTypeDef = { # (1)
"ExtensionIdentifier": ...,
}
parent.delete_extension(**kwargs)
delete_extension_association#
Deletes an extension association.
Type annotations and code completion for boto3.client("appconfig").delete_extension_association
method.
boto3 documentation
# delete_extension_association method definition
def delete_extension_association(
self,
*,
ExtensionAssociationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_extension_association method usage example with argument unpacking
kwargs: DeleteExtensionAssociationRequestRequestTypeDef = { # (1)
"ExtensionAssociationId": ...,
}
parent.delete_extension_association(**kwargs)
delete_hosted_configuration_version#
Deletes a version of a configuration from the AppConfig hosted configuration store.
Type annotations and code completion for boto3.client("appconfig").delete_hosted_configuration_version
method.
boto3 documentation
# delete_hosted_configuration_version method definition
def delete_hosted_configuration_version(
self,
*,
ApplicationId: str,
ConfigurationProfileId: str,
VersionNumber: int,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_hosted_configuration_version method usage example with argument unpacking
kwargs: DeleteHostedConfigurationVersionRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ConfigurationProfileId": ...,
"VersionNumber": ...,
}
parent.delete_hosted_configuration_version(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("appconfig").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:
...
get_application#
Retrieves information about an application.
Type annotations and code completion for boto3.client("appconfig").get_application
method.
boto3 documentation
# get_application method definition
def get_application(
self,
*,
ApplicationId: str,
) -> ApplicationResponseTypeDef: # (1)
...
# get_application method usage example with argument unpacking
kwargs: GetApplicationRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_application(**kwargs)
get_configuration#
(Deprecated) Retrieves the latest deployed configuration.
Type annotations and code completion for boto3.client("appconfig").get_configuration
method.
boto3 documentation
# get_configuration method definition
def get_configuration(
self,
*,
Application: str,
Environment: str,
Configuration: str,
ClientId: str,
ClientConfigurationVersion: str = ...,
) -> ConfigurationTypeDef: # (1)
...
# get_configuration method usage example with argument unpacking
kwargs: GetConfigurationRequestRequestTypeDef = { # (1)
"Application": ...,
"Environment": ...,
"Configuration": ...,
"ClientId": ...,
}
parent.get_configuration(**kwargs)
get_configuration_profile#
Retrieves information about a configuration profile.
Type annotations and code completion for boto3.client("appconfig").get_configuration_profile
method.
boto3 documentation
# get_configuration_profile method definition
def get_configuration_profile(
self,
*,
ApplicationId: str,
ConfigurationProfileId: str,
) -> ConfigurationProfileTypeDef: # (1)
...
# get_configuration_profile method usage example with argument unpacking
kwargs: GetConfigurationProfileRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ConfigurationProfileId": ...,
}
parent.get_configuration_profile(**kwargs)
get_deployment#
Retrieves information about a configuration deployment.
Type annotations and code completion for boto3.client("appconfig").get_deployment
method.
boto3 documentation
# get_deployment method definition
def get_deployment(
self,
*,
ApplicationId: str,
EnvironmentId: str,
DeploymentNumber: int,
) -> DeploymentTypeDef: # (1)
...
# get_deployment method usage example with argument unpacking
kwargs: GetDeploymentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EnvironmentId": ...,
"DeploymentNumber": ...,
}
parent.get_deployment(**kwargs)
get_deployment_strategy#
Retrieves information about a deployment strategy.
Type annotations and code completion for boto3.client("appconfig").get_deployment_strategy
method.
boto3 documentation
# get_deployment_strategy method definition
def get_deployment_strategy(
self,
*,
DeploymentStrategyId: str,
) -> DeploymentStrategyResponseTypeDef: # (1)
...
# get_deployment_strategy method usage example with argument unpacking
kwargs: GetDeploymentStrategyRequestRequestTypeDef = { # (1)
"DeploymentStrategyId": ...,
}
parent.get_deployment_strategy(**kwargs)
get_environment#
Retrieves information about an environment.
Type annotations and code completion for boto3.client("appconfig").get_environment
method.
boto3 documentation
# get_environment method definition
def get_environment(
self,
*,
ApplicationId: str,
EnvironmentId: str,
) -> EnvironmentResponseTypeDef: # (1)
...
# get_environment method usage example with argument unpacking
kwargs: GetEnvironmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EnvironmentId": ...,
}
parent.get_environment(**kwargs)
get_extension#
Returns information about an AppConfig extension.
Type annotations and code completion for boto3.client("appconfig").get_extension
method.
boto3 documentation
# get_extension method definition
def get_extension(
self,
*,
ExtensionIdentifier: str,
VersionNumber: int = ...,
) -> ExtensionTypeDef: # (1)
...
- See ExtensionTypeDef
# get_extension method usage example with argument unpacking
kwargs: GetExtensionRequestRequestTypeDef = { # (1)
"ExtensionIdentifier": ...,
}
parent.get_extension(**kwargs)
get_extension_association#
Returns information about an AppConfig extension association.
Type annotations and code completion for boto3.client("appconfig").get_extension_association
method.
boto3 documentation
# get_extension_association method definition
def get_extension_association(
self,
*,
ExtensionAssociationId: str,
) -> ExtensionAssociationTypeDef: # (1)
...
# get_extension_association method usage example with argument unpacking
kwargs: GetExtensionAssociationRequestRequestTypeDef = { # (1)
"ExtensionAssociationId": ...,
}
parent.get_extension_association(**kwargs)
get_hosted_configuration_version#
Retrieves information about a specific configuration version.
Type annotations and code completion for boto3.client("appconfig").get_hosted_configuration_version
method.
boto3 documentation
# get_hosted_configuration_version method definition
def get_hosted_configuration_version(
self,
*,
ApplicationId: str,
ConfigurationProfileId: str,
VersionNumber: int,
) -> HostedConfigurationVersionTypeDef: # (1)
...
# get_hosted_configuration_version method usage example with argument unpacking
kwargs: GetHostedConfigurationVersionRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ConfigurationProfileId": ...,
"VersionNumber": ...,
}
parent.get_hosted_configuration_version(**kwargs)
list_applications#
Lists all applications in your Amazon Web Services account.
Type annotations and code completion for boto3.client("appconfig").list_applications
method.
boto3 documentation
# list_applications method definition
def list_applications(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ApplicationsTypeDef: # (1)
...
# list_applications method usage example with argument unpacking
kwargs: ListApplicationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_applications(**kwargs)
list_configuration_profiles#
Lists the configuration profiles for an application.
Type annotations and code completion for boto3.client("appconfig").list_configuration_profiles
method.
boto3 documentation
# list_configuration_profiles method definition
def list_configuration_profiles(
self,
*,
ApplicationId: str,
MaxResults: int = ...,
NextToken: str = ...,
Type: str = ...,
) -> ConfigurationProfilesTypeDef: # (1)
...
# list_configuration_profiles method usage example with argument unpacking
kwargs: ListConfigurationProfilesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.list_configuration_profiles(**kwargs)
list_deployment_strategies#
Lists deployment strategies.
Type annotations and code completion for boto3.client("appconfig").list_deployment_strategies
method.