:doc:`odb <../../odb>` / Client / get_oci_onboarding_status

*************************
get_oci_onboarding_status
*************************



.. py:method:: odb.Client.get_oci_onboarding_status()

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/odb-2024-08-20/GetOciOnboardingStatus>`_  


  **Request Syntax**
  ::

    response = client.get_oci_onboarding_status()
    
    
  
  :rtype: 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'
          }
      }
      
    **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.

          
    
  
  **Exceptions**
  
  *   :py:class:`odb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`odb.Client.exceptions.ValidationException`

  
  *   :py:class:`odb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`odb.Client.exceptions.InternalServerException`

  