organization

package
v2.48.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 3, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const OrganizationCreateMutation = `` /* 354-byte string literal not displayed */
View Source 
const OrganizationRevokeSharedAccountMutation = `` /* 299-byte string literal not displayed */
View Source 
const OrganizationUpdateMutation = `` /* 241-byte string literal not displayed */
View Source 
const OrganizationUpdateSharedAccountMutation = `` /* 299-byte string literal not displayed */

Variables

View Source 
var OrganizationRegionCodeEnumTypes = struct {
	// Region code for EU
	EU01 OrganizationRegionCodeEnum
	// Region code for US
	US01 OrganizationRegionCodeEnum
}{

	EU01: "EU01",

	US01: "US01",
}
View Source 
var OrganizationUpdateErrorTypeTypes = struct {
	// Returned when the attributes provided for an object are invalid.
	INVALID_RECORD OrganizationUpdateErrorType
	// Returned when the actor has insufficient capabilties to fulfill the request.
	NOT_AUTHORIZED OrganizationUpdateErrorType
}{

	INVALID_RECORD: "INVALID_RECORD",

	NOT_AUTHORIZED: "NOT_AUTHORIZED",
}

Functions

This section is empty.

Types

type Organization 

type Organization struct {
	// contains filtered or unexported fields
}

func New 

func New(config config.Config) Organization

func (*Organization) OrganizationCreate 

func (a *Organization) OrganizationCreate(
	customerId string,
	newManagedAccount *OrganizationNewManagedAccountInput,
	organization OrganizationCreateOrganizationInput,
	sharedAccount *OrganizationSharedAccountInput,
) (*OrganizationCreateOrganizationResponse, error)

The new organization to create.

func (*Organization) OrganizationCreateWithContext 

func (a *Organization) OrganizationCreateWithContext(
	ctx context.Context,
	customerId string,
	newManagedAccount *OrganizationNewManagedAccountInput,
	organization OrganizationCreateOrganizationInput,
	sharedAccount *OrganizationSharedAccountInput,
) (*OrganizationCreateOrganizationResponse, error)

The new organization to create.

func (*Organization) OrganizationRevokeSharedAccount added in v2.41.0 

func (a *Organization) OrganizationRevokeSharedAccount(
	sharedAccount OrganizationRevokeSharedAccountInput,
) (*OrganizationRevokeSharedAccountResponse, error)

The shared account to revoke

func (*Organization) OrganizationRevokeSharedAccountWithContext added in v2.41.0 

func (a *Organization) OrganizationRevokeSharedAccountWithContext(
	ctx context.Context,
	sharedAccount OrganizationRevokeSharedAccountInput,
) (*OrganizationRevokeSharedAccountResponse, error)

The shared account to revoke

func (*Organization) OrganizationUpdate 

func (a *Organization) OrganizationUpdate(
	organization OrganizationUpdateInput,
	organizationId string,
) (*OrganizationUpdateResponse, error)

The organization to update

func (*Organization) OrganizationUpdateSharedAccount added in v2.36.1 

func (a *Organization) OrganizationUpdateSharedAccount(
	sharedAccount OrganizationUpdateSharedAccountInput,
) (*OrganizationUpdateSharedAccountResponse, error)

The shared account to update

func (*Organization) OrganizationUpdateSharedAccountWithContext added in v2.36.1 

func (a *Organization) OrganizationUpdateSharedAccountWithContext(
	ctx context.Context,
	sharedAccount OrganizationUpdateSharedAccountInput,
) (*OrganizationUpdateSharedAccountResponse, error)

The shared account to update

func (*Organization) OrganizationUpdateWithContext 

func (a *Organization) OrganizationUpdateWithContext(
	ctx context.Context,
	organization OrganizationUpdateInput,
	organizationId string,
) (*OrganizationUpdateResponse, error)

The organization to update

type OrganizationCreateOrganizationInput 

type OrganizationCreateOrganizationInput struct {
	// The name for the new organization.
	Name string `json:"name"`
}

OrganizationCreateOrganizationInput - Attributes belonging to the organization to create.

type OrganizationCreateOrganizationResponse 

type OrganizationCreateOrganizationResponse struct {
	// The job id of the organization creation task; query this job id to get latest state
	JobId string `json:"jobId"`
}

OrganizationCreateOrganizationResponse - The object that's returned from successfully creating an organization.

type OrganizationCreateQueryResponse 

type OrganizationCreateQueryResponse struct {
	OrganizationCreateOrganizationResponse OrganizationCreateOrganizationResponse `json:"OrganizationCreate"`
}

type OrganizationCreateSharedAccountInput 

type OrganizationCreateSharedAccountInput struct {
	// The id of the account to be shared
	AccountID int `json:"accountId"`
	// The id of the limiting role
	LimitingRoleId int `json:"limitingRoleId"`
	// The name of the shared account
	Name string `json:"name,omitempty"`
	// The id of the target organization
	TargetOrganizationId string `json:"targetOrganizationId"`
}

OrganizationCreateSharedAccountInput - Attributes for creating a shared account.

type OrganizationCreateSharedAccountResponse 

type OrganizationCreateSharedAccountResponse struct {
	// The created shared account.
	SharedAccount OrganizationSharedAccount `json:"sharedAccount,omitempty"`
}

OrganizationCreateSharedAccountResponse - The object that's returned from successfully creating a shared account.

type OrganizationError 

type OrganizationError struct {
	// A description of the error.
	Message string `json:"message"`
	// A description of the type of error.
	Type OrganizationUpdateErrorType `json:"type"`
}

OrganizationError - A user-readable error

type OrganizationInformation 

type OrganizationInformation struct {
	// The ID of the organization.
	ID string `json:"id"`
	// The name of the organization.
	Name string `json:"name"`
}

OrganizationInformation - The attributes of an organization.

type OrganizationNewManagedAccountInput 

type OrganizationNewManagedAccountInput struct {
	// The name of the new account to be created.
	Name string `json:"name,omitempty"`
	// The region-code for the account to be created.
	RegionCode OrganizationRegionCodeEnum `json:"regionCode,omitempty"`
}

OrganizationNewManagedAccountInput - Attributes for creating a new managed account.

type OrganizationRegionCodeEnum 

type OrganizationRegionCodeEnum string

OrganizationRegionCodeEnum - Enums for region codes

type OrganizationRevokeSharedAccountInput added in v2.41.0 

type OrganizationRevokeSharedAccountInput struct {
	// The id of the account share to be revoked
	ID string `json:"id"`
}

OrganizationRevokeSharedAccountInput - Attributes for revoking an account share.

type OrganizationRevokeSharedAccountQueryResponse added in v2.41.0 

type OrganizationRevokeSharedAccountQueryResponse struct {
	OrganizationRevokeSharedAccountResponse OrganizationRevokeSharedAccountResponse `json:"OrganizationRevokeSharedAccount"`
}

type OrganizationRevokeSharedAccountResponse added in v2.41.0 

type OrganizationRevokeSharedAccountResponse struct {
	// Information about the revoked shared account.
	SharedAccount OrganizationSharedAccount `json:"sharedAccount,omitempty"`
}

OrganizationRevokeSharedAccountResponse - The object that's returned from successfully revoking a shared account.

type OrganizationSharedAccount 

type OrganizationSharedAccount struct {
	// The ID of the account being shared.
	AccountID int `json:"accountId"`
	// The ID of the account share.
	ID string `json:"id"`
	// The ID of the limiting role for the account share.
	LimitingRoleId int `json:"limitingRoleId"`
	// The name of the account share.
	Name string `json:"name,omitempty"`
	// The ID of the organization sending the account share.
	SourceOrganizationId string `json:"sourceOrganizationId"`
	// The name of the organization sending the account share.
	SourceOrganizationName string `json:"sourceOrganizationName,omitempty"`
	// The ID of the organization receiving the account share.
	TargetOrganizationId string `json:"targetOrganizationId"`
	// The name of the organization receiving the account share.
	TargetOrganizationName string `json:"targetOrganizationName,omitempty"`
}

OrganizationSharedAccount - The attributes of an account share.

type OrganizationSharedAccountInput 

type OrganizationSharedAccountInput struct {
	// The id of the account to share with new organization
	AccountID int `json:"accountId"`
	// The limiting role id the new organization will be granted on for the shared account
	LimitingRoleId int `json:"limitingRoleId,omitempty"`
}

OrganizationSharedAccountInput - Attributes for creating an account share.

type OrganizationUpdateErrorType 

type OrganizationUpdateErrorType string

OrganizationUpdateErrorType - An enum specifying the specific types of errors that may be returned.

type OrganizationUpdateInput 

type OrganizationUpdateInput struct {
	// The new name for the organization.
	Name string `json:"name,omitempty"`
}

OrganizationUpdateInput - Attributes for updating an organization.

type OrganizationUpdateQueryResponse 

type OrganizationUpdateQueryResponse struct {
	OrganizationUpdateResponse OrganizationUpdateResponse `json:"OrganizationUpdate"`
}

type OrganizationUpdateResponse 

type OrganizationUpdateResponse struct {
	// A description of any errors with the mutation.
	Errors []OrganizationError `json:"errors"`
	// Information about the updated organization.
	OrganizationInformation OrganizationInformation `json:"organizationInformation,omitempty"`
}

OrganizationUpdateResponse - The return object for an update mutation.

type OrganizationUpdateSharedAccountInput 

type OrganizationUpdateSharedAccountInput struct {
	// The id of the account share to be updated
	ID string `json:"id"`
	// The id of the limiting role to be updated
	LimitingRoleId int `json:"limitingRoleId"`
}

OrganizationUpdateSharedAccountInput - Attributes for updating an account share.

type OrganizationUpdateSharedAccountQueryResponse added in v2.36.1 

type OrganizationUpdateSharedAccountQueryResponse struct {
	OrganizationUpdateSharedAccountResponse OrganizationUpdateSharedAccountResponse `json:"OrganizationUpdateSharedAccount"`
}

type OrganizationUpdateSharedAccountResponse 

type OrganizationUpdateSharedAccountResponse struct {
	// Information about the updated shared account.
	SharedAccount OrganizationSharedAccount `json:"sharedAccount,omitempty"`
}

OrganizationUpdateSharedAccountResponse - The object that's returned from successfully updating a shared account.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.