CloudWatchOmniClient

Index > CloudWatchOmni > CloudWatchOmniClient

Auto-generated documentation for CloudWatchOmni type annotations stubs module mypy-boto3-cloudwatchomni.

CloudWatchOmniClient

Type annotations and code completion for boto3.client("cloudwatchomni"). boto3 documentation

# CloudWatchOmniClient usage example

from boto3.session import Session
from mypy_boto3_cloudwatchomni.client import CloudWatchOmniClient

def get_cloudwatchomni_client() -> CloudWatchOmniClient:
    return Session().client("cloudwatchomni")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("cloudwatchomni")

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

# Exceptions.exceptions type checking example

from mypy_boto3_cloudwatchomni.client import Exceptions

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

Methods

can_paginate

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

create_access_grant

Creates an AccessGrant that authorizes a principal to perform a set of actions on resources in a space.

Type annotations and code completion for boto3.client("cloudwatchomni").create_access_grant method. boto3 documentation

# create_access_grant method definition

def create_access_grant(
    self,
    *,
    domainId: str,
    spaceId: str,
    name: str,
    principal: AccessGrantPrincipalUnionTypeDef,  # (1)
    permission: AccessGrantPermissionType,  # (2)
    scopedActions: Sequence[ScopedActionsUnionTypeDef] = ...,  # (3)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateAccessGrantOutputTypeDef:  # (4)
    ...

1. See AccessGrantPrincipalUnionTypeDef
2. See AccessGrantPermissionType
3. See Sequence[ScopedActionsUnionTypeDef]
4. See CreateAccessGrantOutputTypeDef

# create_access_grant method usage example with argument unpacking

kwargs: CreateAccessGrantInputTypeDef = {  # (1)
    "domainId": ...,
    "spaceId": ...,
    "name": ...,
    "principal": ...,
    "permission": ...,
}

parent.create_access_grant(**kwargs)

1. See CreateAccessGrantInputTypeDef

create_access_profile

Creates an access profile in a space.

Type annotations and code completion for boto3.client("cloudwatchomni").create_access_profile method. boto3 documentation

# create_access_profile method definition

def create_access_profile(
    self,
    *,
    spaceId: str,
    name: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateAccessProfileOutputTypeDef:  # (1)
    ...

1. See CreateAccessProfileOutputTypeDef

# create_access_profile method usage example with argument unpacking

kwargs: CreateAccessProfileInputTypeDef = {  # (1)
    "spaceId": ...,
    "name": ...,
}

parent.create_access_profile(**kwargs)

1. See CreateAccessProfileInputTypeDef

create_alert

Creates a new alert within a space.

Type annotations and code completion for boto3.client("cloudwatchomni").create_alert method. boto3 documentation

# create_alert method definition

def create_alert(
    self,
    *,
    spaceId: str,
    profileId: str,
    name: str,
    rule: RuleTypeDef,  # (1)
    description: str = ...,
    notificationsEnabled: bool = ...,
    tags: Mapping[str, str] = ...,
    notificationRules: Sequence[NotificationRuleUnionTypeDef] = ...,  # (2)
    clientToken: str = ...,
) -> CreateAlertOutputTypeDef:  # (3)
    ...

1. See RuleTypeDef
2. See Sequence[NotificationRuleUnionTypeDef]
3. See CreateAlertOutputTypeDef

# create_alert method usage example with argument unpacking

kwargs: CreateAlertInputTypeDef = {  # (1)
    "spaceId": ...,
    "profileId": ...,
    "name": ...,
    "rule": ...,
}

parent.create_alert(**kwargs)

1. See CreateAlertInputTypeDef

create_domain

Creates a domain with identity provider configuration.

Type annotations and code completion for boto3.client("cloudwatchomni").create_domain method. boto3 documentation

# create_domain method definition

def create_domain(
    self,
    *,
    name: str,
    identityProviders: Sequence[IdentityProviderType],  # (1)
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateDomainOutputTypeDef:  # (3)
    ...

1. See Sequence[IdentityProviderType]
2. See IdentityProviderConfigurationTypeDef
3. See CreateDomainOutputTypeDef

# create_domain method usage example with argument unpacking

kwargs: CreateDomainInputTypeDef = {  # (1)
    "name": ...,
    "identityProviders": ...,
}

parent.create_domain(**kwargs)

1. See CreateDomainInputTypeDef

create_domain_access_grant_for_organization

Creates an AccessGrant that authorizes a principal to administer an organization domain.

Type annotations and code completion for boto3.client("cloudwatchomni").create_domain_access_grant_for_organization method. boto3 documentation

# create_domain_access_grant_for_organization method definition

def create_domain_access_grant_for_organization(
    self,
    *,
    domainId: str,
    name: str,
    principal: OrganizationAccessGrantPrincipalUnionTypeDef,  # (1)
    permission: OrganizationGrantPermissionType,  # (2)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateDomainAccessGrantForOrganizationOutputTypeDef:  # (3)
    ...

1. See OrganizationAccessGrantPrincipalUnionTypeDef
2. See OrganizationGrantPermissionType
3. See CreateDomainAccessGrantForOrganizationOutputTypeDef

# create_domain_access_grant_for_organization method usage example with argument unpacking

kwargs: CreateDomainAccessGrantForOrganizationInputTypeDef = {  # (1)
    "domainId": ...,
    "name": ...,
    "principal": ...,
    "permission": ...,
}

parent.create_domain_access_grant_for_organization(**kwargs)

1. See CreateDomainAccessGrantForOrganizationInputTypeDef

create_domain_for_organization

Creates an organization-scoped domain for the caller's AWS Organization.

Type annotations and code completion for boto3.client("cloudwatchomni").create_domain_for_organization method. boto3 documentation

# create_domain_for_organization method definition

def create_domain_for_organization(
    self,
    *,
    name: str,
    identityProviders: Sequence[IdentityProviderType],  # (1)
    domainAccessRoleArn: str,
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateDomainForOrganizationOutputTypeDef:  # (3)
    ...

1. See Sequence[IdentityProviderType]
2. See IdentityProviderConfigurationTypeDef
3. See CreateDomainForOrganizationOutputTypeDef

# create_domain_for_organization method usage example with argument unpacking

kwargs: CreateDomainForOrganizationInputTypeDef = {  # (1)
    "name": ...,
    "identityProviders": ...,
    "domainAccessRoleArn": ...,
}

parent.create_domain_for_organization(**kwargs)

1. See CreateDomainForOrganizationInputTypeDef

create_integration

Creates an integration with a third-party provider.

Type annotations and code completion for boto3.client("cloudwatchomni").create_integration method. boto3 documentation

# create_integration method definition

def create_integration(
    self,
    *,
    integrationType: IntegrationTypeType,  # (1)
    name: str,
    credential: IntegrationCredentialTypeDef = ...,  # (2)
    integrationAttributes: Mapping[str, str] = ...,
    roleArn: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateIntegrationOutputTypeDef:  # (3)
    ...

1. See IntegrationTypeType
2. See IntegrationCredentialTypeDef
3. See CreateIntegrationOutputTypeDef

# create_integration method usage example with argument unpacking

kwargs: CreateIntegrationInputTypeDef = {  # (1)
    "integrationType": ...,
    "name": ...,
}

parent.create_integration(**kwargs)

1. See CreateIntegrationInputTypeDef

create_omni_dashboard

Creates a new dashboard within a space.

Type annotations and code completion for boto3.client("cloudwatchomni").create_omni_dashboard method. boto3 documentation

# create_omni_dashboard method definition

def create_omni_dashboard(
    self,
    *,
    spaceId: str,
    name: str,
    body: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateOmniDashboardOutputTypeDef:  # (1)
    ...

1. See CreateOmniDashboardOutputTypeDef

# create_omni_dashboard method usage example with argument unpacking

kwargs: CreateOmniDashboardInputTypeDef = {  # (1)
    "spaceId": ...,
    "name": ...,
    "body": ...,
}

parent.create_omni_dashboard(**kwargs)

1. See CreateOmniDashboardInputTypeDef

create_one_time_deep_link_code

Generates a one-time code for deep-link authentication.

Type annotations and code completion for boto3.client("cloudwatchomni").create_one_time_deep_link_code method. boto3 documentation

# create_one_time_deep_link_code method definition

def create_one_time_deep_link_code(
    self,
    *,
    domainId: str,
    ttlSeconds: int = ...,
    redirectUrl: str = ...,
) -> CreateOneTimeDeepLinkCodeOutputTypeDef:  # (1)
    ...

1. See CreateOneTimeDeepLinkCodeOutputTypeDef

# create_one_time_deep_link_code method usage example with argument unpacking

kwargs: CreateOneTimeDeepLinkCodeInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.create_one_time_deep_link_code(**kwargs)

1. See CreateOneTimeDeepLinkCodeInputTypeDef

create_space

Creates a space in a domain.

Type annotations and code completion for boto3.client("cloudwatchomni").create_space method. boto3 documentation

# create_space method definition

def create_space(
    self,
    *,
    name: str,
    domainId: str,
    dataAccessRoleArn: str,
    agentCoreEvaluationRoleArn: str = ...,
    encryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateSpaceOutputTypeDef:  # (2)
    ...

1. See EncryptionConfigurationTypeDef
2. See CreateSpaceOutputTypeDef

# create_space method usage example with argument unpacking

kwargs: CreateSpaceInputTypeDef = {  # (1)
    "name": ...,
    "domainId": ...,
    "dataAccessRoleArn": ...,
}

parent.create_space(**kwargs)

1. See CreateSpaceInputTypeDef

create_view

Creates a new SQL view.

Type annotations and code completion for boto3.client("cloudwatchomni").create_view method. boto3 documentation

# create_view method definition

def create_view(
    self,
    *,
    name: str,
    definition: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateViewResponseTypeDef:  # (1)
    ...

1. See CreateViewResponseTypeDef

# create_view method usage example with argument unpacking

kwargs: CreateViewRequestTypeDef = {  # (1)
    "name": ...,
    "definition": ...,
}

parent.create_view(**kwargs)

1. See CreateViewRequestTypeDef

delete_access_grant

Removes an existing AccessGrant, revoking the access it granted.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_access_grant method. boto3 documentation

# delete_access_grant method definition

def delete_access_grant(
    self,
    *,
    grantId: str,
) -> dict[str, Any]:
    ...

# delete_access_grant method usage example with argument unpacking

kwargs: DeleteAccessGrantInputTypeDef = {  # (1)
    "grantId": ...,
}

parent.delete_access_grant(**kwargs)

1. See DeleteAccessGrantInputTypeDef

delete_access_profile

Removes an access profile.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_access_profile method. boto3 documentation

# delete_access_profile method definition

def delete_access_profile(
    self,
    *,
    spaceId: str,
    profileId: str,
) -> dict[str, Any]:
    ...

# delete_access_profile method usage example with argument unpacking

kwargs: DeleteAccessProfileInputTypeDef = {  # (1)
    "spaceId": ...,
    "profileId": ...,
}

parent.delete_access_profile(**kwargs)

1. See DeleteAccessProfileInputTypeDef

delete_alert

Deletes an alert by its identifier.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_alert method. boto3 documentation

# delete_alert method definition

def delete_alert(
    self,
    *,
    spaceId: str,
    alertId: str,
) -> dict[str, Any]:
    ...

# delete_alert method usage example with argument unpacking

kwargs: DeleteAlertInputTypeDef = {  # (1)
    "spaceId": ...,
    "alertId": ...,
}

parent.delete_alert(**kwargs)

1. See DeleteAlertInputTypeDef

delete_domain

Removes a domain and all of its resources.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_domain method. boto3 documentation

# delete_domain method definition

def delete_domain(
    self,
    *,
    domainId: str,
) -> dict[str, Any]:
    ...

# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.delete_domain(**kwargs)

1. See DeleteDomainInputTypeDef

delete_domain_access_grant_for_organization

Removes an existing organization access grant, revoking the access it granted.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_domain_access_grant_for_organization method. boto3 documentation

# delete_domain_access_grant_for_organization method definition

def delete_domain_access_grant_for_organization(
    self,
    *,
    grantId: str,
) -> dict[str, Any]:
    ...

# delete_domain_access_grant_for_organization method usage example with argument unpacking

kwargs: DeleteDomainAccessGrantForOrganizationInputTypeDef = {  # (1)
    "grantId": ...,
}

parent.delete_domain_access_grant_for_organization(**kwargs)

1. See DeleteDomainAccessGrantForOrganizationInputTypeDef

delete_domain_for_organization

Removes an organization domain and all of its resources.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_domain_for_organization method. boto3 documentation

# delete_domain_for_organization method definition

def delete_domain_for_organization(
    self,
    *,
    domainId: str,
) -> dict[str, Any]:
    ...

# delete_domain_for_organization method usage example with argument unpacking

kwargs: DeleteDomainForOrganizationInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.delete_domain_for_organization(**kwargs)

1. See DeleteDomainForOrganizationInputTypeDef

delete_integration

Deletes an integration.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_integration method. boto3 documentation

# delete_integration method definition

def delete_integration(
    self,
    *,
    identifier: IntegrationIdentifierTypeDef,  # (1)
) -> dict[str, Any]:
    ...

1. See IntegrationIdentifierTypeDef

# delete_integration method usage example with argument unpacking

kwargs: DeleteIntegrationInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_integration(**kwargs)

1. See DeleteIntegrationInputTypeDef

delete_omni_dashboard

Removes a dashboard from a space.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_omni_dashboard method. boto3 documentation

# delete_omni_dashboard method definition

def delete_omni_dashboard(
    self,
    *,
    spaceId: str,
    dashboardId: str,
) -> dict[str, Any]:
    ...

# delete_omni_dashboard method usage example with argument unpacking

kwargs: DeleteOmniDashboardInputTypeDef = {  # (1)
    "spaceId": ...,
    "dashboardId": ...,
}

parent.delete_omni_dashboard(**kwargs)

1. See DeleteOmniDashboardInputTypeDef

delete_space

Removes a space and all of its resources.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_space method. boto3 documentation

# delete_space method definition

def delete_space(
    self,
    *,
    spaceId: str,
) -> dict[str, Any]:
    ...

# delete_space method usage example with argument unpacking

kwargs: DeleteSpaceInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.delete_space(**kwargs)

1. See DeleteSpaceInputTypeDef

delete_view

Deletes the specified view.

Type annotations and code completion for boto3.client("cloudwatchomni").delete_view method. boto3 documentation

# delete_view method definition

def delete_view(
    self,
    *,
    name: str,
) -> dict[str, Any]:
    ...

# delete_view method usage example with argument unpacking

kwargs: DeleteViewRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_view(**kwargs)

1. See DeleteViewRequestTypeDef

get_access_grant

Retrieves the full detail of a single AccessGrant by ID.

Type annotations and code completion for boto3.client("cloudwatchomni").get_access_grant method. boto3 documentation

# get_access_grant method definition

def get_access_grant(
    self,
    *,
    grantId: str,
) -> GetAccessGrantOutputTypeDef:  # (1)
    ...

1. See GetAccessGrantOutputTypeDef

# get_access_grant method usage example with argument unpacking

kwargs: GetAccessGrantInputTypeDef = {  # (1)
    "grantId": ...,
}

parent.get_access_grant(**kwargs)

1. See GetAccessGrantInputTypeDef

get_access_profile

Retrieves an access profile by ID.

Type annotations and code completion for boto3.client("cloudwatchomni").get_access_profile method. boto3 documentation

# get_access_profile method definition

def get_access_profile(
    self,
    *,
    spaceId: str,
    profileId: str,
) -> GetAccessProfileOutputTypeDef:  # (1)
    ...

1. See GetAccessProfileOutputTypeDef

# get_access_profile method usage example with argument unpacking

kwargs: GetAccessProfileInputTypeDef = {  # (1)
    "spaceId": ...,
    "profileId": ...,
}

parent.get_access_profile(**kwargs)

1. See GetAccessProfileInputTypeDef

get_alert

Retrieves a single alert by its identifier.

Type annotations and code completion for boto3.client("cloudwatchomni").get_alert method. boto3 documentation

# get_alert method definition

def get_alert(
    self,
    *,
    spaceId: str,
    alertId: str,
) -> GetAlertOutputTypeDef:  # (1)
    ...

1. See GetAlertOutputTypeDef

# get_alert method usage example with argument unpacking

kwargs: GetAlertInputTypeDef = {  # (1)
    "spaceId": ...,
    "alertId": ...,
}

parent.get_alert(**kwargs)

1. See GetAlertInputTypeDef

get_context_graph

Queries the context graph with filtering, traversal, and pagination support.

Type annotations and code completion for boto3.client("cloudwatchomni").get_context_graph method. boto3 documentation

# get_context_graph method definition

def get_context_graph(
    self,
    *,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    nodeFilters: NodeFiltersTypeDef = ...,  # (1)
    edgeFilters: EdgeFiltersTypeDef = ...,  # (2)
    depth: int = ...,
    maxResults: int = ...,
    maxEdgesPerNode: int = ...,
    includeMetadata: bool = ...,
    nextToken: str = ...,
) -> GetContextGraphOutputTypeDef:  # (3)
    ...

1. See NodeFiltersTypeDef
2. See EdgeFiltersTypeDef
3. See GetContextGraphOutputTypeDef

# get_context_graph method usage example with argument unpacking

kwargs: GetContextGraphInputTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.get_context_graph(**kwargs)

1. See GetContextGraphInputTypeDef

get_domain

Retrieves the details of a domain by ID.

Type annotations and code completion for boto3.client("cloudwatchomni").get_domain method. boto3 documentation

# get_domain method definition

def get_domain(
    self,
    *,
    domainId: str,
) -> GetDomainOutputTypeDef:  # (1)
    ...

1. See GetDomainOutputTypeDef

# get_domain method usage example with argument unpacking

kwargs: GetDomainInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_domain(**kwargs)

1. See GetDomainInputTypeDef

get_domain_access_grant_for_organization

Retrieves the full detail of a single organization access grant by ID.

Type annotations and code completion for boto3.client("cloudwatchomni").get_domain_access_grant_for_organization method. boto3 documentation

# get_domain_access_grant_for_organization method definition

def get_domain_access_grant_for_organization(
    self,
    *,
    grantId: str,
) -> GetDomainAccessGrantForOrganizationOutputTypeDef:  # (1)
    ...

1. See GetDomainAccessGrantForOrganizationOutputTypeDef

# get_domain_access_grant_for_organization method usage example with argument unpacking

kwargs: GetDomainAccessGrantForOrganizationInputTypeDef = {  # (1)
    "grantId": ...,
}

parent.get_domain_access_grant_for_organization(**kwargs)

1. See GetDomainAccessGrantForOrganizationInputTypeDef

get_domain_for_organization

Retrieves the details of an organization domain by ID.

Type annotations and code completion for boto3.client("cloudwatchomni").get_domain_for_organization method. boto3 documentation

# get_domain_for_organization method definition

def get_domain_for_organization(
    self,
    *,
    domainId: str,
) -> GetDomainForOrganizationOutputTypeDef:  # (1)
    ...

1. See GetDomainForOrganizationOutputTypeDef

# get_domain_for_organization method usage example with argument unpacking

kwargs: GetDomainForOrganizationInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_domain_for_organization(**kwargs)

1. See GetDomainForOrganizationInputTypeDef

get_integration

Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.

Type annotations and code completion for boto3.client("cloudwatchomni").get_integration method. boto3 documentation

# get_integration method definition

def get_integration(
    self,
    *,
    identifier: IntegrationIdentifierTypeDef,  # (1)
) -> GetIntegrationOutputTypeDef:  # (2)
    ...

1. See IntegrationIdentifierTypeDef
2. See GetIntegrationOutputTypeDef

# get_integration method usage example with argument unpacking

kwargs: GetIntegrationInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_integration(**kwargs)

1. See GetIntegrationInputTypeDef

get_intelligence_configuration

Retrieves the intelligence configuration for the calling account.

Type annotations and code completion for boto3.client("cloudwatchomni").get_intelligence_configuration method. boto3 documentation

# get_intelligence_configuration method definition

def get_intelligence_configuration(
    self,
) -> GetIntelligenceConfigurationOutputTypeDef:  # (1)
    ...

1. See GetIntelligenceConfigurationOutputTypeDef

get_omni_dashboard

Retrieves a dashboard by ID within a space.

Type annotations and code completion for boto3.client("cloudwatchomni").get_omni_dashboard method. boto3 documentation

# get_omni_dashboard method definition

def get_omni_dashboard(
    self,
    *,
    spaceId: str,
    dashboardId: str,
) -> GetOmniDashboardOutputTypeDef:  # (1)
    ...

1. See GetOmniDashboardOutputTypeDef

# get_omni_dashboard method usage example with argument unpacking

kwargs: GetOmniDashboardInputTypeDef = {  # (1)
    "spaceId": ...,
    "dashboardId": ...,
}

parent.get_omni_dashboard(**kwargs)

1. See GetOmniDashboardInputTypeDef

get_space

Retrieves the details of a space by ID.

Type annotations and code completion for boto3.client("cloudwatchomni").get_space method. boto3 documentation

# get_space method definition

def get_space(
    self,
    *,
    spaceId: str,
) -> GetSpaceOutputTypeDef:  # (1)
    ...

1. See GetSpaceOutputTypeDef

# get_space method usage example with argument unpacking

kwargs: GetSpaceInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.get_space(**kwargs)

1. See GetSpaceInputTypeDef

get_space_credentials_for_organization

Returns temporary credentials for a space in an organization member account.

Type annotations and code completion for boto3.client("cloudwatchomni").get_space_credentials_for_organization method. boto3 documentation

# get_space_credentials_for_organization method definition

def get_space_credentials_for_organization(
    self,
    *,
    context: SpaceCredentialRequestContextTypeDef,  # (1)
    credentialType: OrganizationCredentialTypeType,  # (2)
) -> GetSpaceCredentialsForOrganizationOutputTypeDef:  # (3)
    ...

1. See SpaceCredentialRequestContextTypeDef
2. See OrganizationCredentialTypeType
3. See GetSpaceCredentialsForOrganizationOutputTypeDef

# get_space_credentials_for_organization method usage example with argument unpacking

kwargs: GetSpaceCredentialsForOrganizationInputTypeDef = {  # (1)
    "context": ...,
    "credentialType": ...,
}

parent.get_space_credentials_for_organization(**kwargs)

1. See GetSpaceCredentialsForOrganizationInputTypeDef

get_telemetry_query_results

Returns the results for the specified query.

Type annotations and code completion for boto3.client("cloudwatchomni").get_telemetry_query_results method. boto3 documentation

# get_telemetry_query_results method definition

def get_telemetry_query_results(
    self,
    *,
    queryId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetTelemetryQueryResultsResponseTypeDef:  # (1)
    ...

1. See GetTelemetryQueryResultsResponseTypeDef

# get_telemetry_query_results method usage example with argument unpacking

kwargs: GetTelemetryQueryResultsRequestTypeDef = {  # (1)
    "queryId": ...,
}

parent.get_telemetry_query_results(**kwargs)

1. See GetTelemetryQueryResultsRequestTypeDef

get_view

Returns the definition and metadata of the specified view.

Type annotations and code completion for boto3.client("cloudwatchomni").get_view method. boto3 documentation

# get_view method definition

def get_view(
    self,
    *,
    name: str,
) -> GetViewResponseTypeDef:  # (1)
    ...

1. See GetViewResponseTypeDef

# get_view method usage example with argument unpacking

kwargs: GetViewRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_view(**kwargs)

1. See GetViewRequestTypeDef

list_access_grants

Returns AccessGrants, with optional filtering by domain, space, principal, or permission.

Type annotations and code completion for boto3.client("cloudwatchomni").list_access_grants method. boto3 documentation

# list_access_grants method definition

def list_access_grants(
    self,
    *,
    domainId: str = ...,
    spaceId: str = ...,
    principalId: str = ...,
    principalType: AccessGrantPrincipalTypeType = ...,  # (1)
    permission: AccessGrantPermissionType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAccessGrantsOutputTypeDef:  # (3)
    ...

1. See AccessGrantPrincipalTypeType
2. See AccessGrantPermissionType
3. See ListAccessGrantsOutputTypeDef

# list_access_grants method usage example with argument unpacking

kwargs: ListAccessGrantsInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_access_grants(**kwargs)

1. See ListAccessGrantsInputTypeDef

list_access_profiles

Returns the access profiles in a space.

Type annotations and code completion for boto3.client("cloudwatchomni").list_access_profiles method. boto3 documentation

# list_access_profiles method definition

def list_access_profiles(
    self,
    *,
    spaceId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAccessProfilesOutputTypeDef:  # (1)
    ...

1. See ListAccessProfilesOutputTypeDef

# list_access_profiles method usage example with argument unpacking

kwargs: ListAccessProfilesInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.list_access_profiles(**kwargs)

1. See ListAccessProfilesInputTypeDef

list_alerts

Lists alerts within a space, optionally filtered by exact name(s), a single name prefix, or exact alertId(s), with pagination.

Type annotations and code completion for boto3.client("cloudwatchomni").list_alerts method. boto3 documentation

# list_alerts method definition

def list_alerts(
    self,
    *,
    spaceId: str,
    filterCriteria: AlertFilterCriteriaTypeDef = ...,  # (1)
    sortBy: AlertSortFieldType = ...,  # (2)
    sortOrder: AlertSortOrderType = ...,  # (3)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAlertsOutputTypeDef:  # (4)
    ...

1. See AlertFilterCriteriaTypeDef
2. See AlertSortFieldType
3. See AlertSortOrderType
4. See ListAlertsOutputTypeDef

# list_alerts method usage example with argument unpacking

kwargs: ListAlertsInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.list_alerts(**kwargs)

1. See ListAlertsInputTypeDef

list_domain_access_grants_for_organization

Returns organization-level domain access grants, with optional filtering by domain, principal, or permission.

Type annotations and code completion for boto3.client("cloudwatchomni").list_domain_access_grants_for_organization method. boto3 documentation

# list_domain_access_grants_for_organization method definition

def list_domain_access_grants_for_organization(
    self,
    *,
    domainId: str = ...,
    principalId: str = ...,
    principalType: OrganizationGrantPrincipalTypeType = ...,  # (1)
    permission: OrganizationGrantPermissionType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDomainAccessGrantsForOrganizationOutputTypeDef:  # (3)
    ...

1. See OrganizationGrantPrincipalTypeType
2. See OrganizationGrantPermissionType
3. See ListDomainAccessGrantsForOrganizationOutputTypeDef

# list_domain_access_grants_for_organization method usage example with argument unpacking

kwargs: ListDomainAccessGrantsForOrganizationInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_domain_access_grants_for_organization(**kwargs)

1. See ListDomainAccessGrantsForOrganizationInputTypeDef

list_domains

Returns the caller's domains: the account-scoped domain and the organization-scoped domain, if either exists.

Type annotations and code completion for boto3.client("cloudwatchomni").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDomainsOutputTypeDef:  # (1)
    ...

1. See ListDomainsOutputTypeDef

# list_domains method usage example with argument unpacking

kwargs: ListDomainsInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_domains(**kwargs)

1. See ListDomainsInputTypeDef

list_integrations

Lists the integrations in the account, optionally filtered by type, status, or name.

Type annotations and code completion for boto3.client("cloudwatchomni").list_integrations method. boto3 documentation

# list_integrations method definition

def list_integrations(
    self,
    *,
    integrationType: IntegrationTypeType = ...,  # (1)
    status: IntegrationStatusType = ...,  # (2)
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListIntegrationsOutputTypeDef:  # (3)
    ...

1. See IntegrationTypeType
2. See IntegrationStatusType
3. See ListIntegrationsOutputTypeDef

# list_integrations method usage example with argument unpacking

kwargs: ListIntegrationsInputTypeDef = {  # (1)
    "integrationType": ...,
}

parent.list_integrations(**kwargs)

1. See ListIntegrationsInputTypeDef

list_omni_dashboards

Returns the dashboards in a space, optionally filtered by name prefix.

Type annotations and code completion for boto3.client("cloudwatchomni").list_omni_dashboards method. boto3 documentation

# list_omni_dashboards method definition

def list_omni_dashboards(
    self,
    *,
    spaceId: str,
    namePrefix: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListOmniDashboardsOutputTypeDef:  # (1)
    ...

1. See ListOmniDashboardsOutputTypeDef

# list_omni_dashboards method usage example with argument unpacking

kwargs: ListOmniDashboardsInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.list_omni_dashboards(**kwargs)

1. See ListOmniDashboardsInputTypeDef

list_spaces

Returns the spaces in the account, optionally filtered by domain.

Type annotations and code completion for boto3.client("cloudwatchomni").list_spaces method. boto3 documentation

# list_spaces method definition

def list_spaces(
    self,
    *,
    domainId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSpacesOutputTypeDef:  # (1)
    ...

1. See ListSpacesOutputTypeDef

# list_spaces method usage example with argument unpacking

kwargs: ListSpacesInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_spaces(**kwargs)

1. See ListSpacesInputTypeDef

list_spaces_for_organization

Returns the spaces across all member accounts in the organization.

Type annotations and code completion for boto3.client("cloudwatchomni").list_spaces_for_organization method. boto3 documentation

# list_spaces_for_organization method definition

def list_spaces_for_organization(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSpacesForOrganizationOutputTypeDef:  # (1)
    ...

1. See ListSpacesForOrganizationOutputTypeDef

# list_spaces_for_organization method usage example with argument unpacking

kwargs: ListSpacesForOrganizationInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_spaces_for_organization(**kwargs)

1. See ListSpacesForOrganizationInputTypeDef

list_telemetry_fields

Lists fields available for telemetry queries.

Type annotations and code completion for boto3.client("cloudwatchomni").list_telemetry_fields method. boto3 documentation

# list_telemetry_fields method definition

def list_telemetry_fields(
    self,
    *,
    dataSetName: str,
    telemetryType: TelemetryTypeType = ...,  # (1)
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    nextToken: str = ...,
) -> ListTelemetryFieldsResponseTypeDef:  # (2)
    ...

1. See TelemetryTypeType
2. See ListTelemetryFieldsResponseTypeDef

# list_telemetry_fields method usage example with argument unpacking

kwargs: ListTelemetryFieldsRequestTypeDef = {  # (1)
    "dataSetName": ...,
}

parent.list_telemetry_fields(**kwargs)

1. See ListTelemetryFieldsRequestTypeDef

list_telemetry_query_sessions

Lists telemetry query sessions.

Type annotations and code completion for boto3.client("cloudwatchomni").list_telemetry_query_sessions method. boto3 documentation

# list_telemetry_query_sessions method definition

def list_telemetry_query_sessions(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTelemetryQuerySessionsResponseTypeDef:  # (1)
    ...

1. See ListTelemetryQuerySessionsResponseTypeDef

# list_telemetry_query_sessions method usage example with argument unpacking

kwargs: ListTelemetryQuerySessionsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_telemetry_query_sessions(**kwargs)

1. See ListTelemetryQuerySessionsRequestTypeDef

list_views

Lists the views in the caller's account and region.

Type annotations and code completion for boto3.client("cloudwatchomni").list_views method. boto3 documentation

# list_views method definition

def list_views(
    self,
    *,
    type: ViewTypeType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListViewsResponseTypeDef:  # (2)
    ...

1. See ViewTypeType
2. See ListViewsResponseTypeDef

# list_views method usage example with argument unpacking

kwargs: ListViewsRequestTypeDef = {  # (1)
    "type": ...,
}

parent.list_views(**kwargs)

1. See ListViewsRequestTypeDef

put_intelligence_configuration

Creates or updates the intelligence configuration for the calling account.

Type annotations and code completion for boto3.client("cloudwatchomni").put_intelligence_configuration method. boto3 documentation

# put_intelligence_configuration method definition

def put_intelligence_configuration(
    self,
    *,
    kmsKeyArn: str = ...,
    removeKmsKey: bool = ...,
    clientToken: str = ...,
) -> PutIntelligenceConfigurationOutputTypeDef:  # (1)
    ...

1. See PutIntelligenceConfigurationOutputTypeDef

# put_intelligence_configuration method usage example with argument unpacking

kwargs: PutIntelligenceConfigurationInputTypeDef = {  # (1)
    "kmsKeyArn": ...,
}

parent.put_intelligence_configuration(**kwargs)

1. See PutIntelligenceConfigurationInputTypeDef

search_principals

Searches Identity Center for users and groups in a domain.

Type annotations and code completion for boto3.client("cloudwatchomni").search_principals method. boto3 documentation

# search_principals method definition

def search_principals(
    self,
    *,
    domainId: str,
    searchQuery: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchPrincipalsOutputTypeDef:  # (1)
    ...

1. See SearchPrincipalsOutputTypeDef

# search_principals method usage example with argument unpacking

kwargs: SearchPrincipalsInputTypeDef = {  # (1)
    "domainId": ...,
    "searchQuery": ...,
}

parent.search_principals(**kwargs)

1. See SearchPrincipalsInputTypeDef

start_telemetry_query

Starts a telemetry query within a session.

Type annotations and code completion for boto3.client("cloudwatchomni").start_telemetry_query method. boto3 documentation

# start_telemetry_query method definition

def start_telemetry_query(
    self,
    *,
    queryString: str,
    sessionId: str,
) -> StartTelemetryQueryResponseTypeDef:  # (1)
    ...

1. See StartTelemetryQueryResponseTypeDef

# start_telemetry_query method usage example with argument unpacking

kwargs: StartTelemetryQueryRequestTypeDef = {  # (1)
    "queryString": ...,
    "sessionId": ...,
}

parent.start_telemetry_query(**kwargs)

1. See StartTelemetryQueryRequestTypeDef

start_telemetry_query_session

Starts a new telemetry query session.

Type annotations and code completion for boto3.client("cloudwatchomni").start_telemetry_query_session method. boto3 documentation

# start_telemetry_query_session method definition

def start_telemetry_query_session(
    self,
    *,
    sessionName: str = ...,
) -> StartTelemetryQuerySessionResponseTypeDef:  # (1)
    ...

1. See StartTelemetryQuerySessionResponseTypeDef

# start_telemetry_query_session method usage example with argument unpacking

kwargs: StartTelemetryQuerySessionRequestTypeDef = {  # (1)
    "sessionName": ...,
}

parent.start_telemetry_query_session(**kwargs)

1. See StartTelemetryQuerySessionRequestTypeDef

stop_telemetry_query

Stops a running telemetry query.

Type annotations and code completion for boto3.client("cloudwatchomni").stop_telemetry_query method. boto3 documentation

# stop_telemetry_query method definition

def stop_telemetry_query(
    self,
    *,
    queryId: str,
) -> dict[str, Any]:
    ...

# stop_telemetry_query method usage example with argument unpacking

kwargs: StopTelemetryQueryRequestTypeDef = {  # (1)
    "queryId": ...,
}

parent.stop_telemetry_query(**kwargs)

1. See StopTelemetryQueryRequestTypeDef

stop_telemetry_query_session

Stops a telemetry query session.

Type annotations and code completion for boto3.client("cloudwatchomni").stop_telemetry_query_session method. boto3 documentation

# stop_telemetry_query_session method definition

def stop_telemetry_query_session(
    self,
    *,
    sessionId: str,
) -> dict[str, Any]:
    ...

# stop_telemetry_query_session method usage example with argument unpacking

kwargs: StopTelemetryQuerySessionRequestTypeDef = {  # (1)
    "sessionId": ...,
}

parent.stop_telemetry_query_session(**kwargs)

1. See StopTelemetryQuerySessionRequestTypeDef

update_access_profile

Updates the name or description of an access profile.

Type annotations and code completion for boto3.client("cloudwatchomni").update_access_profile method. boto3 documentation

# update_access_profile method definition

def update_access_profile(
    self,
    *,
    spaceId: str,
    profileId: str,
    name: str = ...,
    description: str = ...,
) -> UpdateAccessProfileOutputTypeDef:  # (1)
    ...

1. See UpdateAccessProfileOutputTypeDef

# update_access_profile method usage example with argument unpacking

kwargs: UpdateAccessProfileInputTypeDef = {  # (1)
    "spaceId": ...,
    "profileId": ...,
}

parent.update_access_profile(**kwargs)

1. See UpdateAccessProfileInputTypeDef

update_alert

Updates an existing alert.

Type annotations and code completion for boto3.client("cloudwatchomni").update_alert method. boto3 documentation

# update_alert method definition

def update_alert(
    self,
    *,
    spaceId: str,
    alertId: str,
    profileId: str = ...,
    name: str = ...,
    description: str = ...,
    rule: RuleTypeDef = ...,  # (1)
    notificationsEnabled: bool = ...,
    notificationRules: Sequence[NotificationRuleUnionTypeDef] = ...,  # (2)
) -> dict[str, Any]:
    ...

1. See RuleTypeDef
2. See Sequence[NotificationRuleUnionTypeDef]

# update_alert method usage example with argument unpacking

kwargs: UpdateAlertInputTypeDef = {  # (1)
    "spaceId": ...,
    "alertId": ...,
}

parent.update_alert(**kwargs)

1. See UpdateAlertInputTypeDef

update_domain

Updates a domain's name or identity provider configuration.

Type annotations and code completion for boto3.client("cloudwatchomni").update_domain method. boto3 documentation

# update_domain method definition

def update_domain(
    self,
    *,
    domainId: str,
    name: str = ...,
    identityProviders: Sequence[IdentityProviderType] = ...,  # (1)
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef = ...,  # (2)
) -> UpdateDomainOutputTypeDef:  # (3)
    ...

1. See Sequence[IdentityProviderType]
2. See IdentityProviderConfigurationTypeDef
3. See UpdateDomainOutputTypeDef

# update_domain method usage example with argument unpacking

kwargs: UpdateDomainInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.update_domain(**kwargs)

1. See UpdateDomainInputTypeDef

update_domain_for_organization

Updates an organization domain's name or identity provider configuration.

Type annotations and code completion for boto3.client("cloudwatchomni").update_domain_for_organization method. boto3 documentation

# update_domain_for_organization method definition

def update_domain_for_organization(
    self,
    *,
    domainId: str,
    name: str = ...,
    identityProviders: Sequence[IdentityProviderType] = ...,  # (1)
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef = ...,  # (2)
) -> UpdateDomainForOrganizationOutputTypeDef:  # (3)
    ...

1. See Sequence[IdentityProviderType]
2. See IdentityProviderConfigurationTypeDef
3. See UpdateDomainForOrganizationOutputTypeDef

# update_domain_for_organization method usage example with argument unpacking

kwargs: UpdateDomainForOrganizationInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.update_domain_for_organization(**kwargs)

1. See UpdateDomainForOrganizationInputTypeDef

update_integration

Updates an existing integration, identified by its id, ARN, or name.

Type annotations and code completion for boto3.client("cloudwatchomni").update_integration method. boto3 documentation

# update_integration method definition

def update_integration(
    self,
    *,
    identifier: IntegrationIdentifierTypeDef,  # (1)
    credential: IntegrationCredentialTypeDef = ...,  # (2)
    integrationAttributes: Mapping[str, str] = ...,
    roleArn: str = ...,
) -> UpdateIntegrationOutputTypeDef:  # (3)
    ...

1. See IntegrationIdentifierTypeDef
2. See IntegrationCredentialTypeDef
3. See UpdateIntegrationOutputTypeDef

# update_integration method usage example with argument unpacking

kwargs: UpdateIntegrationInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_integration(**kwargs)

1. See UpdateIntegrationInputTypeDef

update_omni_dashboard

Updates an existing dashboard within a space.

Type annotations and code completion for boto3.client("cloudwatchomni").update_omni_dashboard method. boto3 documentation

# update_omni_dashboard method definition

def update_omni_dashboard(
    self,
    *,
    spaceId: str,
    dashboardId: str,
    body: str = ...,
    name: str = ...,
    description: str = ...,
) -> UpdateOmniDashboardOutputTypeDef:  # (1)
    ...

1. See UpdateOmniDashboardOutputTypeDef

# update_omni_dashboard method usage example with argument unpacking

kwargs: UpdateOmniDashboardInputTypeDef = {  # (1)
    "spaceId": ...,
    "dashboardId": ...,
}

parent.update_omni_dashboard(**kwargs)

1. See UpdateOmniDashboardInputTypeDef

update_space

Updates a space.

Type annotations and code completion for boto3.client("cloudwatchomni").update_space method. boto3 documentation

# update_space method definition

def update_space(
    self,
    *,
    spaceId: str,
    name: str = ...,
    encryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (1)
) -> UpdateSpaceOutputTypeDef:  # (2)
    ...

1. See EncryptionConfigurationTypeDef
2. See UpdateSpaceOutputTypeDef

# update_space method usage example with argument unpacking

kwargs: UpdateSpaceInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.update_space(**kwargs)

1. See UpdateSpaceInputTypeDef

update_view

Updates an existing view's definition and/or description.

Type annotations and code completion for boto3.client("cloudwatchomni").update_view method. boto3 documentation

# update_view method definition

def update_view(
    self,
    *,
    name: str,
    definition: str = ...,
    description: str = ...,
) -> UpdateViewResponseTypeDef:  # (1)
    ...

1. See UpdateViewResponseTypeDef

# update_view method usage example with argument unpacking

kwargs: UpdateViewRequestTypeDef = {  # (1)
    "name": ...,
}

parent.update_view(**kwargs)

1. See UpdateViewRequestTypeDef

get_paginator

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

• client.get_paginator("get_context_graph") -> GetContextGraphPaginator
• client.get_paginator("get_telemetry_query_results") -> GetTelemetryQueryResultsPaginator
• client.get_paginator("list_access_grants") -> ListAccessGrantsPaginator
• client.get_paginator("list_access_profiles") -> ListAccessProfilesPaginator
• client.get_paginator("list_alerts") -> ListAlertsPaginator
• client.get_paginator("list_domain_access_grants_for_organization") -> ListDomainAccessGrantsForOrganizationPaginator
• client.get_paginator("list_domains") -> ListDomainsPaginator
• client.get_paginator("list_integrations") -> ListIntegrationsPaginator
• client.get_paginator("list_omni_dashboards") -> ListOmniDashboardsPaginator
• client.get_paginator("list_spaces_for_organization") -> ListSpacesForOrganizationPaginator
• client.get_paginator("list_spaces") -> ListSpacesPaginator
• client.get_paginator("list_telemetry_fields") -> ListTelemetryFieldsPaginator
• client.get_paginator("list_telemetry_query_sessions") -> ListTelemetryQuerySessionsPaginator
• client.get_paginator("list_views") -> ListViewsPaginator
• client.get_paginator("search_principals") -> SearchPrincipalsPaginator