SenderInvitationClient

class oci.tenant_manager_control_plane.SenderInvitationClient(config, **kwargs)

The Organizations API allows you to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and its resources.

Methods

__init__(config, **kwargs) Creates a new service client
cancel_sender_invitation(…) Cancels a sender invitation.
create_sender_invitation(…) Creates a sender invitation and asynchronously sends the invitation to the recipient.
get_sender_invitation(sender_invitation_id, …) Gets information about the sender invitation.
list_sender_invitations(compartment_id, **kwargs) Return a (paginated) list of sender invitations.
update_sender_invitation(…) Updates the SenderInvitation.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

cancel_sender_invitation(sender_invitation_id, **kwargs)

Cancels a sender invitation.

Parameters:
  • sender_invitation_id (str) – (required) OCID of the sender invitation to cancel.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request, so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use cancel_sender_invitation API.

create_sender_invitation(create_sender_invitation_details, **kwargs)

Creates a sender invitation and asynchronously sends the invitation to the recipient.

Parameters:
  • create_sender_invitation_details (oci.tenant_manager_control_plane.models.CreateSenderInvitationDetails) – (required) Parameters for sender invitation creation.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request, so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SenderInvitation

Return type:

Response

Example:

Click here to see an example of how to use create_sender_invitation API.

get_sender_invitation(sender_invitation_id, **kwargs)

Gets information about the sender invitation.

Parameters:
  • sender_invitation_id (str) – (required) OCID of the sender invitation to retrieve.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SenderInvitation

Return type:

Response

Example:

Click here to see an example of how to use get_sender_invitation API.

list_sender_invitations(compartment_id, **kwargs)

Return a (paginated) list of sender invitations.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • recipient_tenancy_id (str) – (optional) The tenancy that the invitation is addressed to.
  • lifecycle_state (str) –

    (optional) The lifecycle state of the resource.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “FAILED”, “TERMINATED”

  • status (str) –

    (optional) The status of the sender invitation.

    Allowed values are: “PENDING”, “CANCELED”, “ACCEPTED”, “EXPIRED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_by (str) –

    (optional) The field to sort by. Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default.

    Allowed values are: “timeCreated”, “displayName”

  • sort_order (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SenderInvitationCollection

Return type:

Response

Example:

Click here to see an example of how to use list_sender_invitations API.

update_sender_invitation(sender_invitation_id, update_sender_invitation_details, **kwargs)

Updates the SenderInvitation.

Parameters:
  • sender_invitation_id (str) – (required) OCID of the sender invitation to update.
  • update_sender_invitation_details (oci.tenant_manager_control_plane.models.UpdateSenderInvitationDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SenderInvitation

Return type:

Response

Example:

Click here to see an example of how to use update_sender_invitation API.