PIClient#
Auto-generated documentation for PI type annotations stubs module mypy-boto3-pi.
PIClient#
Type annotations and code completion for boto3.client("pi")
.
boto3 documentation
# PIClient usage example
from boto3.session import Session
from mypy_boto3_pi.client import PIClient
def get_pi_client() -> PIClient:
return Session().client("pi")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("pi").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("pi")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.InternalServiceError,
client.exceptions.InvalidArgumentException,
client.exceptions.NotAuthorizedException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_pi.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("pi").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("pi").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
describe_dimension_keys#
For a specific time period, retrieve the top N
dimension keys for a metric.
Type annotations and code completion for boto3.client("pi").describe_dimension_keys
method.
boto3 documentation
# describe_dimension_keys method definition
def describe_dimension_keys(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Metric: str,
GroupBy: DimensionGroupTypeDef, # (2)
PeriodInSeconds: int = ...,
AdditionalMetrics: Sequence[str] = ...,
PartitionBy: DimensionGroupTypeDef = ..., # (2)
Filter: Mapping[str, str] = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeDimensionKeysResponseTypeDef: # (4)
...
- See ServiceTypeType
- See DimensionGroupTypeDef
- See DimensionGroupTypeDef
- See DescribeDimensionKeysResponseTypeDef
# describe_dimension_keys method usage example with argument unpacking
kwargs: DescribeDimensionKeysRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"StartTime": ...,
"EndTime": ...,
"Metric": ...,
"GroupBy": ...,
}
parent.describe_dimension_keys(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("pi").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_dimension_key_details#
Get the attributes of the specified dimension group for a DB instance or data source.
Type annotations and code completion for boto3.client("pi").get_dimension_key_details
method.
boto3 documentation
# get_dimension_key_details method definition
def get_dimension_key_details(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
Group: str,
GroupIdentifier: str,
RequestedDimensions: Sequence[str] = ...,
) -> GetDimensionKeyDetailsResponseTypeDef: # (2)
...
# get_dimension_key_details method usage example with argument unpacking
kwargs: GetDimensionKeyDetailsRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"Group": ...,
"GroupIdentifier": ...,
}
parent.get_dimension_key_details(**kwargs)
get_resource_metadata#
Retrieve the metadata for different features.
Type annotations and code completion for boto3.client("pi").get_resource_metadata
method.
boto3 documentation
# get_resource_metadata method definition
def get_resource_metadata(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
) -> GetResourceMetadataResponseTypeDef: # (2)
...
# get_resource_metadata method usage example with argument unpacking
kwargs: GetResourceMetadataRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
}
parent.get_resource_metadata(**kwargs)
get_resource_metrics#
Retrieve Performance Insights metrics for a set of data sources over a time period.
Type annotations and code completion for boto3.client("pi").get_resource_metrics
method.
boto3 documentation
# get_resource_metrics method definition
def get_resource_metrics(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
MetricQueries: Sequence[MetricQueryTypeDef], # (2)
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
PeriodInSeconds: int = ...,
MaxResults: int = ...,
NextToken: str = ...,
PeriodAlignment: PeriodAlignmentType = ..., # (3)
) -> GetResourceMetricsResponseTypeDef: # (4)
...
- See ServiceTypeType
- See MetricQueryTypeDef
- See PeriodAlignmentType
- See GetResourceMetricsResponseTypeDef
# get_resource_metrics method usage example with argument unpacking
kwargs: GetResourceMetricsRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"MetricQueries": ...,
"StartTime": ...,
"EndTime": ...,
}
parent.get_resource_metrics(**kwargs)
list_available_resource_dimensions#
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
Type annotations and code completion for boto3.client("pi").list_available_resource_dimensions
method.
boto3 documentation
# list_available_resource_dimensions method definition
def list_available_resource_dimensions(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
Metrics: Sequence[str],
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAvailableResourceDimensionsResponseTypeDef: # (2)
...
# list_available_resource_dimensions method usage example with argument unpacking
kwargs: ListAvailableResourceDimensionsRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"Metrics": ...,
}
parent.list_available_resource_dimensions(**kwargs)
list_available_resource_metrics#
Retrieve metrics of the specified types that can be queried for a specified DB instance.
Type annotations and code completion for boto3.client("pi").list_available_resource_metrics
method.
boto3 documentation
# list_available_resource_metrics method definition
def list_available_resource_metrics(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
MetricTypes: Sequence[str],
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAvailableResourceMetricsResponseTypeDef: # (2)
...
# list_available_resource_metrics method usage example with argument unpacking
kwargs: ListAvailableResourceMetricsRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"MetricTypes": ...,
}
parent.list_available_resource_metrics(**kwargs)