Skip to content

AppConfigClient#

Index > AppConfig > 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)
    ...
  1. See ApplicationResponseTypeDef
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

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 = ...,
    KmsKeyIdentifier: str = ...,
) -> ConfigurationProfileTypeDef:  # (2)
    ...
  1. See ValidatorTypeDef
  2. See ConfigurationProfileTypeDef
# create_configuration_profile method usage example with argument unpacking

kwargs: CreateConfigurationProfileRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "Name": ...,
    "LocationUri": ...,
}

parent.create_configuration_profile(**kwargs)
  1. See CreateConfigurationProfileRequestRequestTypeDef

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)
    ...
  1. See GrowthTypeType
  2. See ReplicateToType
  3. See DeploymentStrategyResponseTypeDef
# create_deployment_strategy method usage example with argument unpacking

kwargs: CreateDeploymentStrategyRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "DeploymentDurationInMinutes": ...,
    "GrowthFactor": ...,
}

parent.create_deployment_strategy(**kwargs)
  1. See CreateDeploymentStrategyRequestRequestTypeDef

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)
    ...
  1. See MonitorTypeDef
  2. See EnvironmentResponseTypeDef
# create_environment method usage example with argument unpacking

kwargs: CreateEnvironmentRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "Name": ...,
}

parent.create_environment(**kwargs)
  1. See CreateEnvironmentRequestRequestTypeDef

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)
    ...
  1. See ActionPointType ActionTypeDef
  2. See ParameterTypeDef
  3. See ExtensionTypeDef
# create_extension method usage example with argument unpacking

kwargs: CreateExtensionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Actions": ...,
}

parent.create_extension(**kwargs)
  1. See CreateExtensionRequestRequestTypeDef

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)
    ...
  1. See ExtensionAssociationTypeDef
# create_extension_association method usage example with argument unpacking

kwargs: CreateExtensionAssociationRequestRequestTypeDef = {  # (1)
    "ExtensionIdentifier": ...,
    "ResourceIdentifier": ...,
}

parent.create_extension_association(**kwargs)
  1. See CreateExtensionAssociationRequestRequestTypeDef

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)
    ...
  1. See HostedConfigurationVersionTypeDef
# create_hosted_configuration_version method usage example with argument unpacking

kwargs: CreateHostedConfigurationVersionRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "ConfigurationProfileId": ...,
    "Content": ...,
    "ContentType": ...,
}

parent.create_hosted_configuration_version(**kwargs)
  1. See CreateHostedConfigurationVersionRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTyp