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:
...
create_performance_analysis_report#
Creates a new performance analysis report for a specific time period for the DB instance.
Type annotations and code completion for boto3.client("pi").create_performance_analysis_report
method.
boto3 documentation
# create_performance_analysis_report method definition
def create_performance_analysis_report(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreatePerformanceAnalysisReportResponseTypeDef: # (3)
...
# create_performance_analysis_report method usage example with argument unpacking
kwargs: CreatePerformanceAnalysisReportRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"StartTime": ...,
"EndTime": ...,
}
parent.create_performance_analysis_report(**kwargs)
delete_performance_analysis_report#
Deletes a performance analysis report.
Type annotations and code completion for boto3.client("pi").delete_performance_analysis_report
method.
boto3 documentation
# delete_performance_analysis_report method definition
def delete_performance_analysis_report(
self,
*,
ServiceType: ServiceTypeType, # (1)
Identifier: str,
AnalysisReportId: str,
) -> Dict[str, Any]:
...
- See ServiceTypeType
# delete_performance_analysis_report method usage example with argument unpacking
kwargs: DeletePerformanceAnalysisReportRequestRequestTypeDef = { # (1)
"ServiceType": ...,
"Identifier": ...,
"AnalysisReportId": ...,
}
parent.delete_performance_analysis_report(**kwargs)
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: TimestampTypeDef,
EndTime: TimestampTypeDef,
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.