odb / Client / get_oci_onboarding_status

get_oci_onboarding_status¶

odb.Client.get_oci_onboarding_status()¶

Returns the tenancy activation link and onboarding status for your Amazon Web Services account.

Request Syntax

response = client.get_oci_onboarding_status()

Return type:

dict

Returns:

Response Syntax

{
    'status': 'NOT_STARTED'|'PENDING_LINK_GENERATION'|'PENDING_CUSTOMER_ACTION'|'PENDING_INITIALIZATION'|'ACTIVATING'|'ACTIVE_IN_HOME_REGION'|'ACTIVE'|'ACTIVE_LIMITED'|'FAILED'|'PUBLIC_OFFER_UNSUPPORTED'|'SUSPENDED'|'CANCELED',
    'existingTenancyActivationLink': 'string',
    'newTenancyActivationLink': 'string',
    'ociIdentityDomain': {
        'ociIdentityDomainId': 'string',
        'ociIdentityDomainResourceUrl': 'string',
        'ociIdentityDomainUrl': 'string',
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
        'statusReason': 'string',
        'accountSetupCloudFormationUrl': 'string'
    },
    'autonomousDatabaseOciIntegrationIamRoles': [
        {
            'iamRoleArn': 'string',
            'awsIntegration': 'KmsTde'
        },
    ],
    'linkedOciTenancyId': 'string',
    'linkedOciCompartmentId': 'string',
    'subscriptionErrors': [
        {
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- status (string) –
- existingTenancyActivationLink (string) –
  
  The existing OCI tenancy activation link for your Amazon Web Services account.
- newTenancyActivationLink (string) –
  
  A new OCI tenancy activation link for your Amazon Web Services account.
- ociIdentityDomain (dict) –
  
  The Oracle Cloud Infrastructure (OCI) identity domain information in the onboarding status response.
  - ociIdentityDomainId (string) –
    
    The unique identifier of the OCI identity domain.
  - ociIdentityDomainResourceUrl (string) –
    
    The resource URL for accessing the OCI identity domain.
  - ociIdentityDomainUrl (string) –
    
    The URL of the OCI identity domain.
  - status (string) –
    
    The current status of the OCI identity domain.
  - statusReason (string) –
    
    Additional information about the current status of the OCI identity domain, if applicable.
  - accountSetupCloudFormationUrl (string) –
    
    The Amazon Web Services CloudFormation URL for setting up the account integration with the OCI identity domain.
- autonomousDatabaseOciIntegrationIamRoles (list) –
  
  The list of Amazon Web Services Identity and Access Management (IAM) service roles used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI).
  - (dict) –
    
    Information about an Amazon Web Services Identity and Access Management (IAM) service role used for Autonomous Database integration with Oracle Cloud Infrastructure (OCI).
    - iamRoleArn (string) –
      
      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
    - awsIntegration (string) –
      
      The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.
- linkedOciTenancyId (string) –
  
  The unique identifier of the Oracle Cloud Infrastructure (OCI) tenancy that is linked to your Amazon Web Services account.
- linkedOciCompartmentId (string) –
  
  The unique identifier of the Oracle Cloud Infrastructure (OCI) compartment that is linked to your Amazon Web Services account.
- subscriptionErrors (list) –
  
  The list of errors that occurred during the subscription process for your Amazon Web Services account, if any.
  - (dict) –
    
    Information about an error that occurred during the subscription process.
    - errorMessage (string) –
      
      A human-readable message that describes the subscription error.

Exceptions

odb.Client.exceptions.ThrottlingException
odb.Client.exceptions.ValidationException
odb.Client.exceptions.AccessDeniedException
odb.Client.exceptions.InternalServerException