AWS API Changes

2026/03/05 - Connect Health - 16 new api methods

Changes Connect-Health SDK is AWS's unified SDK for the Amazon Connect Health offering. It allows healthcare developers to integrate purpose-built agents - such as patient insights, ambient documentation, and medical coding - into their existing applications, including EHRs, telehealth, and revenue cycle.

UntagResource (new)

Link ¶

Removes the specified tags from the specified resource

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource to untag

type tagKeys:

list

param tagKeys:

[REQUIRED]

The tag keys to remove from the resource

(string) --

returns:

None

StartPatientInsightsJob (new)

Link ¶

Starts a new patient insights job.

See also: AWS API Documentation

Request Syntax

client.start_patient_insights_job(
    domainId='string',
    patientContext={
        'patientId': 'string',
        'dateOfBirth': 'string',
        'pronouns': 'HE_HIM'|'SHE_HER'|'THEY_THEM'
    },
    insightsContext={
        'insightsType': 'PRE_VISIT'
    },
    encounterContext={
        'encounterReason': 'string'
    },
    userContext={
        'role': 'CLINICIAN',
        'userId': 'string',
        'specialty': 'PRIMARY_CARE'
    },
    inputDataConfig={
        'fhirServer': {
            'fhirEndpoint': 'string',
            'oauthToken': 'string'
        },
        's3Sources': [
            {
                'uri': 'string'
            },
        ]
    },
    outputDataConfig={
        's3OutputPath': 'string'
    },
    clientToken='string'
)

type domainId:

string

param domainId:

[REQUIRED]

type patientContext:

dict

param patientContext:

[REQUIRED]

patientId (string) -- [REQUIRED]

Unique identifier of the patient
dateOfBirth (string) --

Date of birth of the patient.
pronouns (string) --

Pronouns preferred by the patient.

type insightsContext:

dict

param insightsContext:

[REQUIRED]

insightsType (string) -- [REQUIRED]

type encounterContext:

dict

param encounterContext:

[REQUIRED]

encounterReason (string) -- [REQUIRED]

Chief complaint for the visit

type userContext:

dict

param userContext:

[REQUIRED]

role (string) -- [REQUIRED]
userId (string) -- [REQUIRED]

Unique identifier of the user
specialty (string) --

type inputDataConfig:

dict

param inputDataConfig:

[REQUIRED]

fhirServer (dict) --

FHIR server configuration to retrieve patient data.
- fhirEndpoint (string) -- [REQUIRED]
  
  FHIR server endpoint URL for accessing patient data.
- oauthToken (string) --
  
  OAuth token for authenticating with the FHIR server.
s3Sources (list) --

List of S3 sources containing patient data.
- (dict) --
  
  S3 uri for input data source
  - uri (string) -- [REQUIRED]
    
    The S3 URI.

type outputDataConfig:

dict

param outputDataConfig:

[REQUIRED]

s3OutputPath (string) -- [REQUIRED]

S3 URI where the insights output will be stored.

type clientToken:

string

param clientToken:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'jobArn': 'string',
    'jobId': 'string',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- jobArn (string) --
- jobId (string) --
- creationTime (datetime) --
  
  Date and time the patient insights job was submitted.

GetSubscription (new)

Link ¶

Retrieves information about a Subscription.

See also: AWS API Documentation

Request Syntax

client.get_subscription(
    domainId='string',
    subscriptionId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the parent Domain.

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The unique identifier of the Subscription.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        'domainId': 'string',
        'subscriptionId': 'string',
        'arn': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DELETED',
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'activatedAt': datetime(2015, 1, 1),
        'deactivatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- subscription (dict) --
  - domainId (string) --
  - subscriptionId (string) --
  - arn (string) --
  - status (string) --
  - createdAt (datetime) --
  - lastUpdatedAt (datetime) --
  - activatedAt (datetime) --
  - deactivatedAt (datetime) --

GetDomain (new)

Link ¶

Retrieves information about a Domain.

See also: AWS API Documentation

Request Syntax

client.get_domain(
    domainId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The id of the Domain to get

rtype:

dict

returns:

Response Syntax

{
    'domainId': 'string',
    'arn': 'string',
    'name': 'string',
    'kmsKeyArn': 'string',
    'encryptionContext': {
        'encryptionType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY',
        'kmsKeyArn': 'string'
    },
    'status': 'ACTIVE'|'DELETING'|'DELETED',
    'webAppUrl': 'string',
    'webAppConfiguration': {
        'ehrRole': 'string',
        'idcApplicationId': 'string',
        'idcRegion': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- domainId (string) --
- arn (string) --
- name (string) --
- kmsKeyArn (string) --
- encryptionContext (dict) --
  - encryptionType (string) --
    
    The type of encryption key used.
  - kmsKeyArn (string) --
    
    The ARN of the KMS key. Only present when encryptionType is CUSTOMER_MANAGED_KEY.
- status (string) --
- webAppUrl (string) --
- webAppConfiguration (dict) --
  - ehrRole (string) --
    
    ARN of the IAM role used for EHR operations.
  - idcApplicationId (string) --
    
    The Identity Center application ID associated with this Domain.
  - idcRegion (string) --
    
    The AWS region where Identity Center is configured.
- createdAt (datetime) --
- tags (dict) --
  
  Tags associated with the Domain
  - (string) --
    - (string) --

StartMedicalScribeListeningSession (new)

Link ¶

Starts a new Medical Scribe listening session for real-time audio transcription

See also: AWS API Documentation

Request Syntax

client.start_medical_scribe_listening_session(
    sessionId='string',
    domainId='string',
    subscriptionId='string',
    languageCode='en-US',
    mediaSampleRateHertz=123,
    mediaEncoding='pcm'|'flac',
    inputStream={...}
)

type sessionId:

string

param sessionId:

[REQUIRED]

The Session identifier

type domainId:

string

param domainId:

[REQUIRED]

The Domain identifier

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The Subscription identifier

type languageCode:

string

param languageCode:

[REQUIRED]

The Language Code for the audio in the session

type mediaSampleRateHertz:

integer

param mediaSampleRateHertz:

[REQUIRED]

The sample rate of the input audio

type mediaEncoding:

string

param mediaEncoding:

[REQUIRED]

The encoding for the input audio

type inputStream:

dict

param inputStream:

rtype:

dict

returns:

The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.

Response Syntax

{
    'sessionId': 'string',
    'domainId': 'string',
    'subscriptionId': 'string',
    'requestId': 'string',
    'languageCode': 'en-US',
    'mediaSampleRateHertz': 123,
    'mediaEncoding': 'pcm'|'flac',
    'responseStream': EventStream({
        'transcriptEvent': {
            'transcriptSegment': {
                'segmentId': 'string',
                'audioBeginOffset': 123.0,
                'audioEndOffset': 123.0,
                'isPartial': True|False,
                'channelId': 'string',
                'content': 'string'
            }
        },
        'internalFailureException': {
            'message': 'string'
        },
        'validationException': {
            'message': 'string'
        }
    })
}

Response Structure

(dict) --
- sessionId (string) --
  
  The Session identifier
- domainId (string) --
  
  The Domain identifier
- subscriptionId (string) --
  
  The Subscription identifier
- requestId (string) --
  
  The Request identifier
- languageCode (string) --
  
  The Language Code for the audio in the session
- mediaSampleRateHertz (integer) --
  
  The sample rate of the input audio
- mediaEncoding (string) --
  
  The encoding for the input audio
- responseStream (:class:`.EventStream`) --
  
  The output stream containing transcript events
  - transcriptEvent (dict) --
    - transcriptSegment (dict) --
      
      A segment of the transcript
      - segmentId (string) --
        
        The unique identifier for this segment
      - audioBeginOffset (float) --
        
        The offset from audio start when the audio for this segment begins
      - audioEndOffset (float) --
        
        The offset from audio start when the audio for this segment ends
      - isPartial (boolean) --
        
        Indicates whether this is a partial or final transcript
      - channelId (string) --
        
        The channel identifier for this segment
      - content (string) --
        
        The transcript text content
  - internalFailureException (dict) --
    - message (string) --
  - validationException (dict) --
    - message (string) --

ListDomains (new)

Link ¶

Lists Domains for a given account.

See also: AWS API Documentation

Request Syntax

client.list_domains(
    status='ACTIVE'|'DELETING'|'DELETED',
    maxResults=123,
    nextToken='string'
)

type status:

string

param status:

Filter by Domain status.

type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

Token for pagination.

rtype:

dict

returns:

Response Syntax

{
    'domains': [
        {
            'domainId': 'string',
            'arn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'DELETING'|'DELETED',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- domains (list) --
  
  List of Domains.
  - (dict) --
    
    Summary information about a Domain.
    - domainId (string) --
      
      The unique identifier of the Domain.
    - arn (string) --
    - name (string) --
    - status (string) --
    - createdAt (datetime) --
      
      The timestamp when the Domain was created.
- nextToken (string) --
  
  Token for the next page of results.

CreateDomain (new)

Link ¶

Creates a new Domain for managing HealthAgent resources.

See also: AWS API Documentation

Request Syntax

client.create_domain(
    name='string',
    kmsKeyArn='string',
    webAppSetupConfiguration={
        'ehrRole': 'string',
        'idcInstanceId': 'string',
        'idcRegion': 'string'
    },
    tags={
        'string': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name for the new Domain.

type kmsKeyArn:

string

param kmsKeyArn:

The ARN of the KMS key to use for encrypting data in this Domain.

type webAppSetupConfiguration:

dict

param webAppSetupConfiguration:

Configuration for the Domain web application. Optional, but if provided all fields are required.

ehrRole (string) -- [REQUIRED]

ARN of the IAM role used for EHR operations.
idcInstanceId (string) -- [REQUIRED]

The Identity Center instance ID to use for creating the application.
idcRegion (string) -- [REQUIRED]

The AWS region where Identity Center is configured.

type tags:

dict

param tags:

Tags to associate with the Domain.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'domainId': 'string',
    'arn': 'string',
    'name': 'string',
    'kmsKeyArn': 'string',
    'encryptionContext': {
        'encryptionType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY',
        'kmsKeyArn': 'string'
    },
    'status': 'ACTIVE'|'DELETING'|'DELETED',
    'webAppUrl': 'string',
    'webAppConfiguration': {
        'ehrRole': 'string',
        'idcApplicationId': 'string',
        'idcRegion': 'string'
    },
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- domainId (string) --
- arn (string) --
- name (string) --
- kmsKeyArn (string) --
- encryptionContext (dict) --
  - encryptionType (string) --
    
    The type of encryption key used.
  - kmsKeyArn (string) --
    
    The ARN of the KMS key. Only present when encryptionType is CUSTOMER_MANAGED_KEY.
- status (string) --
- webAppUrl (string) --
- webAppConfiguration (dict) --
  - ehrRole (string) --
    
    ARN of the IAM role used for EHR operations.
  - idcApplicationId (string) --
    
    The Identity Center application ID associated with this Domain.
  - idcRegion (string) --
    
    The AWS region where Identity Center is configured.
- createdAt (datetime) --

DeactivateSubscription (new)

Link ¶

Deactivates a Subscription to stop billing for a user.

See also: AWS API Documentation

Request Syntax

client.deactivate_subscription(
    domainId='string',
    subscriptionId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the parent Domain.

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The unique identifier of the Subscription.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        'domainId': 'string',
        'subscriptionId': 'string',
        'arn': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DELETED',
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'activatedAt': datetime(2015, 1, 1),
        'deactivatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- subscription (dict) --
  - domainId (string) --
  - subscriptionId (string) --
  - arn (string) --
  - status (string) --
  - createdAt (datetime) --
  - lastUpdatedAt (datetime) --
  - activatedAt (datetime) --
  - deactivatedAt (datetime) --

GetMedicalScribeListeningSession (new)

Link ¶

Retrieves details about an existing Medical Scribe listening session

See also: AWS API Documentation

Request Syntax

client.get_medical_scribe_listening_session(
    sessionId='string',
    domainId='string',
    subscriptionId='string'
)

type sessionId:

string

param sessionId:

[REQUIRED]

The Session identifier

type domainId:

string

param domainId:

[REQUIRED]

The Domain identifier

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The Subscription identifier

rtype:

dict

returns:

Response Syntax

{
    'medicalScribeListeningSessionDetails': {
        'sessionId': 'string',
        'domainId': 'string',
        'subscriptionId': 'string',
        'languageCode': 'en-US',
        'mediaSampleRateHertz': 123,
        'mediaEncoding': 'pcm'|'flac',
        'channelDefinitions': [
            {
                'channelId': 123,
                'participantRole': 'PATIENT'|'CLINICIAN'
            },
        ],
        'postStreamActionSettings': {
            'outputS3Uri': 'string',
            'clinicalNoteGenerationSettings': {
                'noteTemplateSettings': {
                    'managedTemplate': {
                        'templateType': 'HISTORY_AND_PHYSICAL'|'GIRPP'|'DAP'|'SIRP'|'BIRP'|'BEHAVIORAL_SOAP'|'PHYSICAL_SOAP'
                    },
                    'customTemplate': {
                        'templateType': 'HISTORY_AND_PHYSICAL'|'GIRPP'|'DAP'|'SIRP'|'BIRP'|'BEHAVIORAL_SOAP'
                    }
                }
            }
        },
        'postStreamActionResult': {
            'clinicalNoteGenerationResult': {
                'noteResult': {
                    'outputLocation': 'string',
                    'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'failureReason': 'string'
                },
                'transcriptResult': {
                    'outputLocation': 'string',
                    'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'failureReason': 'string'
                },
                'afterVisitSummaryResult': {
                    'outputLocation': 'string',
                    'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'failureReason': 'string'
                }
            }
        },
        'encounterContextProvided': True|False,
        'streamStatus': 'IN_PROGRESS'|'PAUSED'|'FAILED'|'COMPLETED',
        'streamCreationTime': datetime(2015, 1, 1),
        'streamEndTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- medicalScribeListeningSessionDetails (dict) --
  
  Details about the Medical Scribe listening session
  - sessionId (string) --
    
    The Session identifier
  - domainId (string) --
    
    The Domain identifier
  - subscriptionId (string) --
    
    The Subscription identifier
  - languageCode (string) --
    
    The Language Code for the audio in the session
  - mediaSampleRateHertz (integer) --
    
    The sample rate of the input audio
  - mediaEncoding (string) --
    
    The encoding for the input audio
  - channelDefinitions (list) --
    
    Channel definitions for the audio stream
    - (dict) --
      
      Defines a channel in the audio stream
      - channelId (integer) --
        
        The channel identifier
      - participantRole (string) --
        
        The role of the participant on this channel
  - postStreamActionSettings (dict) --
    
    Settings for post-stream actions
    - outputS3Uri (string) --
    - clinicalNoteGenerationSettings (dict) --
      
      Settings for clinical note generation
      - noteTemplateSettings (dict) --
        
        Settings for the note template used
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: managedTemplate, customTemplate. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        managedTemplate (dict) --
        
        templateType (string) --
        
        The type of managed template used
        
        customTemplate (dict) --
        
        templateType (string) --
        
        The base template type that was customized
  - postStreamActionResult (dict) --
    
    Results of post-stream actions
    - clinicalNoteGenerationResult (dict) --
      
      Results of clinical note generation
      - noteResult (dict) --
        
        Details about the generated clinical note
        
        outputLocation (string) --
        
        status (string) --
        
        The generation status of the artifact
        
        failureReason (string) --
        
        The reason for failure if the artifact generation failed
      - transcriptResult (dict) --
        
        Details about the generated transcript
        
        outputLocation (string) --
        
        status (string) --
        
        The generation status of the artifact
        
        failureReason (string) --
        
        The reason for failure if the artifact generation failed
      - afterVisitSummaryResult (dict) --
        
        Details about the generated after visit summary
        
        outputLocation (string) --
        
        status (string) --
        
        The generation status of the artifact
        
        failureReason (string) --
        
        The reason for failure if the artifact generation failed
  - encounterContextProvided (boolean) --
    
    Indicates whether encounter context was provided
  - streamStatus (string) --
    
    The current status of the stream
  - streamCreationTime (datetime) --
    
    The timestamp when the stream was created
  - streamEndTime (datetime) --
    
    The timestamp when the stream ended

GetPatientInsightsJob (new)

Link ¶

Get details of a started patient insights job.

See also: AWS API Documentation

Request Syntax

client.get_patient_insights_job(
    domainId='string',
    jobId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

type jobId:

string

param jobId:

[REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    'jobArn': 'string',
    'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
    'creationTime': datetime(2015, 1, 1),
    'updatedTime': datetime(2015, 1, 1),
    'insightsOutput': {
        'uri': 'string'
    },
    'statusDetails': 'string',
    'patientContext': {
        'patientId': 'string',
        'dateOfBirth': 'string',
        'pronouns': 'HE_HIM'|'SHE_HER'|'THEY_THEM'
    },
    'insightsContext': {
        'insightsType': 'PRE_VISIT'
    },
    'encounterContext': {
        'encounterReason': 'string'
    },
    'userContext': {
        'role': 'CLINICIAN',
        'userId': 'string',
        'specialty': 'PRIMARY_CARE'
    },
    'inputDataConfig': {
        'fhirServer': {
            'fhirEndpoint': 'string',
            'oauthToken': 'string'
        },
        's3Sources': [
            {
                'uri': 'string'
            },
        ]
    },
    'outputDataConfig': {
        's3OutputPath': 'string'
    }
}

Response Structure

(dict) --
- jobId (string) --
- jobArn (string) --
- jobStatus (string) --
- creationTime (datetime) --
  
  Date and time the patient insights job was submitted.
- updatedTime (datetime) --
  
  Date and time the patient insights job was last updated.
- insightsOutput (dict) --
  - uri (string) --
- statusDetails (string) --
  
  Contains information about the status of a job.
- patientContext (dict) --
  - patientId (string) --
    
    Unique identifier of the patient
  - dateOfBirth (string) --
    
    Date of birth of the patient.
  - pronouns (string) --
    
    Pronouns preferred by the patient.
- insightsContext (dict) --
  - insightsType (string) --
- encounterContext (dict) --
  - encounterReason (string) --
    
    Chief complaint for the visit
- userContext (dict) --
  - role (string) --
  - userId (string) --
    
    Unique identifier of the user
  - specialty (string) --
- inputDataConfig (dict) --
  - fhirServer (dict) --
    
    FHIR server configuration to retrieve patient data.
    - fhirEndpoint (string) --
      
      FHIR server endpoint URL for accessing patient data.
    - oauthToken (string) --
      
      OAuth token for authenticating with the FHIR server.
  - s3Sources (list) --
    
    List of S3 sources containing patient data.
    - (dict) --
      
      S3 uri for input data source
      - uri (string) --
        
        The S3 URI.
- outputDataConfig (dict) --
  - s3OutputPath (string) --
    
    S3 URI where the insights output will be stored.

ListTagsForResource (new)

Link ¶

Lists the tags associated with the specified resource

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource to list tags for

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  The tags associated with the resource
  - (string) --
    - (string) --

ActivateSubscription (new)

Link ¶

Activates a Subscription to enable billing for a user.

See also: AWS API Documentation

Request Syntax

client.activate_subscription(
    domainId='string',
    subscriptionId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the parent Domain.

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The unique identifier of the Subscription.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        'domainId': 'string',
        'subscriptionId': 'string',
        'arn': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DELETED',
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'activatedAt': datetime(2015, 1, 1),
        'deactivatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- subscription (dict) --
  - domainId (string) --
  - subscriptionId (string) --
  - arn (string) --
  - status (string) --
  - createdAt (datetime) --
  - lastUpdatedAt (datetime) --
  - activatedAt (datetime) --
  - deactivatedAt (datetime) --

DeleteDomain (new)

Link ¶

Deletes a Domain and all associated resources.

See also: AWS API Documentation

Request Syntax

client.delete_domain(
    domainId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The id of the Domain to delete

rtype:

dict

returns:

Response Syntax

{
    'domainId': 'string',
    'arn': 'string',
    'status': 'ACTIVE'|'DELETING'|'DELETED'
}

Response Structure

(dict) --
- domainId (string) --
  
  The id of the Domain requested for deletion
- arn (string) --
  
  The ARN of the Domain that was requested for deletion
- status (string) --
  
  Current status of Domain

ListSubscriptions (new)

Link ¶

Lists all Subscriptions within a Domain.

See also: AWS API Documentation

Request Syntax

client.list_subscriptions(
    domainId='string',
    maxResults=123,
    nextToken='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the parent Domain.

type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

Token for pagination.

rtype:

dict

returns:

Response Syntax

{
    'subscriptions': [
        {
            'domainId': 'string',
            'subscriptionId': 'string',
            'arn': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DELETED',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'activatedAt': datetime(2015, 1, 1),
            'deactivatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- subscriptions (list) --
  
  List of Subscriptions.
  - (dict) --
    
    Complete subscription resource data.
    - domainId (string) --
    - subscriptionId (string) --
    - arn (string) --
    - status (string) --
    - createdAt (datetime) --
    - lastUpdatedAt (datetime) --
    - activatedAt (datetime) --
    - deactivatedAt (datetime) --
- nextToken (string) --
  
  Token for the next page of results.

CreateSubscription (new)

Link ¶

Creates a new Subscription within a Domain for billing and user management.

See also: AWS API Documentation

Request Syntax

client.create_subscription(
    domainId='string'
)

type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the parent Domain.

rtype:

dict

returns:

Response Syntax

{
    'domainId': 'string',
    'subscriptionId': 'string',
    'arn': 'string',
    'status': 'ACTIVE'|'INACTIVE'|'DELETED',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'activatedAt': datetime(2015, 1, 1),
    'deactivatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- domainId (string) --
- subscriptionId (string) --
- arn (string) --
- status (string) --
- createdAt (datetime) --
- lastUpdatedAt (datetime) --
- activatedAt (datetime) --
- deactivatedAt (datetime) --

TagResource (new)

Link ¶

Associates the specified tags with the specified resource

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource to tag

type tags:

dict

param tags:

[REQUIRED]

The tags to add to the resource

(string) --
- (string) --

returns:

None