CloudWatchApplicationSignalsClient

Index > CloudWatchApplicationSignals > CloudWatchApplicationSignalsClient

Auto-generated documentation for CloudWatchApplicationSignals type annotations stubs module types-boto3-application-signals.

CloudWatchApplicationSignalsClient

Type annotations and code completion for boto3.client("application-signals"). boto3 documentation

# CloudWatchApplicationSignalsClient usage example

from boto3.session import Session
from types_boto3_application_signals.client import CloudWatchApplicationSignalsClient

def get_application-signals_client() -> CloudWatchApplicationSignalsClient:
    return Session().client("application-signals")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("application-signals")

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

# Exceptions.exceptions type checking example

from types_boto3_application_signals.client import Exceptions

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

Methods

can_paginate

Type annotations and code completion for boto3.client("application-signals").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("application-signals").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:
    ...

batch_get_service_level_objective_budget_report

Use this operation to retrieve one or more service level objective (SLO) budget reports.

Type annotations and code completion for boto3.client("application-signals").batch_get_service_level_objective_budget_report method. boto3 documentation

# batch_get_service_level_objective_budget_report method definition

def batch_get_service_level_objective_budget_report(
    self,
    *,
    Timestamp: TimestampTypeDef,
    SloIds: Sequence[str],
) -> BatchGetServiceLevelObjectiveBudgetReportOutputTypeDef:  # (1)
    ...

1. See BatchGetServiceLevelObjectiveBudgetReportOutputTypeDef

# batch_get_service_level_objective_budget_report method usage example with argument unpacking

kwargs: BatchGetServiceLevelObjectiveBudgetReportInputTypeDef = {  # (1)
    "Timestamp": ...,
    "SloIds": ...,
}

parent.batch_get_service_level_objective_budget_report(**kwargs)

1. See BatchGetServiceLevelObjectiveBudgetReportInputTypeDef

batch_update_exclusion_windows

Add or remove time window exclusions for one or more Service Level Objectives (SLOs).

Type annotations and code completion for boto3.client("application-signals").batch_update_exclusion_windows method. boto3 documentation

# batch_update_exclusion_windows method definition

def batch_update_exclusion_windows(
    self,
    *,
    SloIds: Sequence[str],
    AddExclusionWindows: Sequence[ExclusionWindowUnionTypeDef] = ...,  # (1)
    RemoveExclusionWindows: Sequence[ExclusionWindowUnionTypeDef] = ...,  # (1)
) -> BatchUpdateExclusionWindowsOutputTypeDef:  # (3)
    ...

1. See Sequence[ExclusionWindowUnionTypeDef]
2. See Sequence[ExclusionWindowUnionTypeDef]
3. See BatchUpdateExclusionWindowsOutputTypeDef

# batch_update_exclusion_windows method usage example with argument unpacking

kwargs: BatchUpdateExclusionWindowsInputTypeDef = {  # (1)
    "SloIds": ...,
}

parent.batch_update_exclusion_windows(**kwargs)

1. See BatchUpdateExclusionWindowsInputTypeDef

create_service_level_objective

Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.

Type annotations and code completion for boto3.client("application-signals").create_service_level_objective method. boto3 documentation

# create_service_level_objective method definition

def create_service_level_objective(
    self,
    *,
    Name: str,
    Description: str = ...,
    SliConfig: ServiceLevelIndicatorConfigTypeDef = ...,  # (1)
    RequestBasedSliConfig: RequestBasedServiceLevelIndicatorConfigTypeDef = ...,  # (2)
    Goal: GoalUnionTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    BurnRateConfigurations: Sequence[BurnRateConfigurationTypeDef] = ...,  # (5)
) -> CreateServiceLevelObjectiveOutputTypeDef:  # (6)
    ...

1. See ServiceLevelIndicatorConfigTypeDef
2. See RequestBasedServiceLevelIndicatorConfigTypeDef
3. See GoalUnionTypeDef
4. See Sequence[TagTypeDef]
5. See Sequence[BurnRateConfigurationTypeDef]
6. See CreateServiceLevelObjectiveOutputTypeDef

# create_service_level_objective method usage example with argument unpacking

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

parent.create_service_level_objective(**kwargs)

1. See CreateServiceLevelObjectiveInputTypeDef

delete_grouping_configuration

Deletes a grouping configuration that defines how services are grouped and organized in Application Signals.

Type annotations and code completion for boto3.client("application-signals").delete_grouping_configuration method. boto3 documentation

# delete_grouping_configuration method definition

def delete_grouping_configuration(
    self,
) -> Dict[str, Any]:
    ...

delete_service_level_objective

Deletes the specified service level objective.

Type annotations and code completion for boto3.client("application-signals").delete_service_level_objective method. boto3 documentation

# delete_service_level_objective method definition

def delete_service_level_objective(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

# delete_service_level_objective method usage example with argument unpacking

kwargs: DeleteServiceLevelObjectiveInputTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_service_level_objective(**kwargs)

1. See DeleteServiceLevelObjectiveInputTypeDef

get_service

Returns information about a service discovered by Application Signals.

Type annotations and code completion for boto3.client("application-signals").get_service method. boto3 documentation

# get_service method definition

def get_service(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    KeyAttributes: Mapping[str, str],
) -> GetServiceOutputTypeDef:  # (1)
    ...

1. See GetServiceOutputTypeDef

# get_service method usage example with argument unpacking

kwargs: GetServiceInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
    "KeyAttributes": ...,
}

parent.get_service(**kwargs)

1. See GetServiceInputTypeDef

get_service_level_objective

Returns information about one SLO created in the account.

Type annotations and code completion for boto3.client("application-signals").get_service_level_objective method. boto3 documentation

# get_service_level_objective method definition

def get_service_level_objective(
    self,
    *,
    Id: str,
) -> GetServiceLevelObjectiveOutputTypeDef:  # (1)
    ...

1. See GetServiceLevelObjectiveOutputTypeDef

# get_service_level_objective method usage example with argument unpacking

kwargs: GetServiceLevelObjectiveInputTypeDef = {  # (1)
    "Id": ...,
}

parent.get_service_level_objective(**kwargs)

1. See GetServiceLevelObjectiveInputTypeDef

list_audit_findings

Retrieves a list of audit findings for Application Signals resources.

Type annotations and code completion for boto3.client("application-signals").list_audit_findings method. boto3 documentation

# list_audit_findings method definition

def list_audit_findings(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    AuditTargets: Sequence[AuditTargetTypeDef],  # (1)
    Auditors: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAuditFindingsOutputTypeDef:  # (2)
    ...

1. See Sequence[AuditTargetTypeDef]
2. See ListAuditFindingsOutputTypeDef

# list_audit_findings method usage example with argument unpacking

kwargs: ListAuditFindingsInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
    "AuditTargets": ...,
}

parent.list_audit_findings(**kwargs)

1. See ListAuditFindingsInputTypeDef

list_grouping_attribute_definitions

Retrieves the available grouping attribute definitions that can be used to create grouping configurations.

Type annotations and code completion for boto3.client("application-signals").list_grouping_attribute_definitions method. boto3 documentation

# list_grouping_attribute_definitions method definition

def list_grouping_attribute_definitions(
    self,
    *,
    NextToken: str = ...,
) -> ListGroupingAttributeDefinitionsOutputTypeDef:  # (1)
    ...

1. See ListGroupingAttributeDefinitionsOutputTypeDef

# list_grouping_attribute_definitions method usage example with argument unpacking

kwargs: ListGroupingAttributeDefinitionsInputTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_grouping_attribute_definitions(**kwargs)

1. See ListGroupingAttributeDefinitionsInputTypeDef

list_service_dependencies

Returns a list of service dependencies of the service that you specify.

Type annotations and code completion for boto3.client("application-signals").list_service_dependencies method. boto3 documentation

# list_service_dependencies method definition

def list_service_dependencies(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    KeyAttributes: Mapping[str, str],
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListServiceDependenciesOutputTypeDef:  # (1)
    ...

1. See ListServiceDependenciesOutputTypeDef

# list_service_dependencies method usage example with argument unpacking

kwargs: ListServiceDependenciesInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
    "KeyAttributes": ...,
}

parent.list_service_dependencies(**kwargs)

1. See ListServiceDependenciesInputTypeDef

list_service_dependents

Returns the list of dependents that invoked the specified service during the provided time range.

Type annotations and code completion for boto3.client("application-signals").list_service_dependents method. boto3 documentation

# list_service_dependents method definition

def list_service_dependents(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    KeyAttributes: Mapping[str, str],
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListServiceDependentsOutputTypeDef:  # (1)
    ...

1. See ListServiceDependentsOutputTypeDef

# list_service_dependents method usage example with argument unpacking

kwargs: ListServiceDependentsInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
    "KeyAttributes": ...,
}

parent.list_service_dependents(**kwargs)

1. See ListServiceDependentsInputTypeDef

list_service_level_objective_exclusion_windows

Retrieves all exclusion windows configured for a specific SLO.

Type annotations and code completion for boto3.client("application-signals").list_service_level_objective_exclusion_windows method. boto3 documentation

# list_service_level_objective_exclusion_windows method definition

def list_service_level_objective_exclusion_windows(
    self,
    *,
    Id: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListServiceLevelObjectiveExclusionWindowsOutputTypeDef:  # (1)
    ...

1. See ListServiceLevelObjectiveExclusionWindowsOutputTypeDef

# list_service_level_objective_exclusion_windows method usage example with argument unpacking

kwargs: ListServiceLevelObjectiveExclusionWindowsInputTypeDef = {  # (1)
    "Id": ...,
}

parent.list_service_level_objective_exclusion_windows(**kwargs)

1. See ListServiceLevelObjectiveExclusionWindowsInputTypeDef

list_service_level_objectives

Returns a list of SLOs created in this account.

Type annotations and code completion for boto3.client("application-signals").list_service_level_objectives method. boto3 documentation

# list_service_level_objectives method definition

def list_service_level_objectives(
    self,
    *,
    KeyAttributes: Mapping[str, str] = ...,
    OperationName: str = ...,
    DependencyConfig: DependencyConfigUnionTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    IncludeLinkedAccounts: bool = ...,
    SloOwnerAwsAccountId: str = ...,
    MetricSourceTypes: Sequence[MetricSourceTypeType] = ...,  # (2)
) -> ListServiceLevelObjectivesOutputTypeDef:  # (3)
    ...

1. See DependencyConfigUnionTypeDef
2. See Sequence[MetricSourceTypeType]
3. See ListServiceLevelObjectivesOutputTypeDef

# list_service_level_objectives method usage example with argument unpacking

kwargs: ListServiceLevelObjectivesInputTypeDef = {  # (1)
    "KeyAttributes": ...,
}

parent.list_service_level_objectives(**kwargs)

1. See ListServiceLevelObjectivesInputTypeDef

list_service_operations

Returns a list of the operations of this service that have been discovered by Application Signals.

Type annotations and code completion for boto3.client("application-signals").list_service_operations method. boto3 documentation

# list_service_operations method definition

def list_service_operations(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    KeyAttributes: Mapping[str, str],
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListServiceOperationsOutputTypeDef:  # (1)
    ...

1. See ListServiceOperationsOutputTypeDef

# list_service_operations method usage example with argument unpacking

kwargs: ListServiceOperationsInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
    "KeyAttributes": ...,
}

parent.list_service_operations(**kwargs)

1. See ListServiceOperationsInputTypeDef

list_service_states

Retrieves the current state information for services monitored by Application Signals.

Type annotations and code completion for boto3.client("application-signals").list_service_states method. boto3 documentation

# list_service_states method definition

def list_service_states(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    MaxResults: int = ...,
    NextToken: str = ...,
    IncludeLinkedAccounts: bool = ...,
    AwsAccountId: str = ...,
    AttributeFilters: Sequence[AttributeFilterUnionTypeDef] = ...,  # (1)
) -> ListServiceStatesOutputTypeDef:  # (2)
    ...

1. See Sequence[AttributeFilterUnionTypeDef]
2. See ListServiceStatesOutputTypeDef

# list_service_states method usage example with argument unpacking

kwargs: ListServiceStatesInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
}

parent.list_service_states(**kwargs)

1. See ListServiceStatesInputTypeDef

list_services

Returns a list of services that have been discovered by Application Signals.

Type annotations and code completion for boto3.client("application-signals").list_services method. boto3 documentation

# list_services method definition

def list_services(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    MaxResults: int = ...,
    NextToken: str = ...,
    IncludeLinkedAccounts: bool = ...,
    AwsAccountId: str = ...,
) -> ListServicesOutputTypeDef:  # (1)
    ...

1. See ListServicesOutputTypeDef

# list_services method usage example with argument unpacking

kwargs: ListServicesInputTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
}

parent.list_services(**kwargs)

1. See ListServicesInputTypeDef

list_tags_for_resource

Displays the tags associated with a CloudWatch resource.

Type annotations and code completion for boto3.client("application-signals").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

put_grouping_configuration

Creates or updates a grouping configuration that defines how services are organized and grouped in Application Signals dashboards and service maps.

Type annotations and code completion for boto3.client("application-signals").put_grouping_configuration method. boto3 documentation

# put_grouping_configuration method definition

def put_grouping_configuration(
    self,
    *,
    GroupingAttributeDefinitions: Sequence[GroupingAttributeDefinitionUnionTypeDef],  # (1)
) -> PutGroupingConfigurationOutputTypeDef:  # (2)
    ...

1. See Sequence[GroupingAttributeDefinitionUnionTypeDef]
2. See PutGroupingConfigurationOutputTypeDef

# put_grouping_configuration method usage example with argument unpacking

kwargs: PutGroupingConfigurationInputTypeDef = {  # (1)
    "GroupingAttributeDefinitions": ...,
}

parent.put_grouping_configuration(**kwargs)

1. See PutGroupingConfigurationInputTypeDef

start_discovery

Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role.

Type annotations and code completion for boto3.client("application-signals").start_discovery method. boto3 documentation

# start_discovery method definition

def start_discovery(
    self,
) -> Dict[str, Any]:
    ...

tag_resource

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.

Type annotations and code completion for boto3.client("application-signals").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("application-signals").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_service_level_objective

Updates an existing service level objective (SLO).

Type annotations and code completion for boto3.client("application-signals").update_service_level_objective method. boto3 documentation

# update_service_level_objective method definition

def update_service_level_objective(
    self,
    *,
    Id: str,
    Description: str = ...,
    SliConfig: ServiceLevelIndicatorConfigTypeDef = ...,  # (1)
    RequestBasedSliConfig: RequestBasedServiceLevelIndicatorConfigTypeDef = ...,  # (2)
    Goal: GoalUnionTypeDef = ...,  # (3)
    BurnRateConfigurations: Sequence[BurnRateConfigurationTypeDef] = ...,  # (4)
) -> UpdateServiceLevelObjectiveOutputTypeDef:  # (5)
    ...

1. See ServiceLevelIndicatorConfigTypeDef
2. See RequestBasedServiceLevelIndicatorConfigTypeDef
3. See GoalUnionTypeDef
4. See Sequence[BurnRateConfigurationTypeDef]
5. See UpdateServiceLevelObjectiveOutputTypeDef

# update_service_level_objective method usage example with argument unpacking

kwargs: UpdateServiceLevelObjectiveInputTypeDef = {  # (1)
    "Id": ...,
}

parent.update_service_level_objective(**kwargs)

1. See UpdateServiceLevelObjectiveInputTypeDef

get_paginator

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

• client.get_paginator("list_service_dependencies") -> ListServiceDependenciesPaginator
• client.get_paginator("list_service_dependents") -> ListServiceDependentsPaginator
• client.get_paginator("list_service_level_objective_exclusion_windows") -> ListServiceLevelObjectiveExclusionWindowsPaginator
• client.get_paginator("list_service_level_objectives") -> ListServiceLevelObjectivesPaginator
• client.get_paginator("list_service_operations") -> ListServiceOperationsPaginator
• client.get_paginator("list_service_states") -> ListServiceStatesPaginator
• client.get_paginator("list_services") -> ListServicesPaginator