Documentation ¶
Overview ¶
It also provides some helper functions for the struct to make it easier to work with.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ListAccountsForParentPaginator ¶
type ListAccountsForParentPaginator interface { HasMorePages() bool NextPage(ctx context.Context, optFns ...func(*organizations.Options), ) ( *organizations.ListAccountsForParentOutput, error, ) }
--- ListAccountsForParentPaginator ------------------------------------------ ListAccountsForParentPaginator is an interface for the organizations ListAccountsForParentPaginator function in the AWS SDK that allows for mocking, this is a paginator function so it has a HasMorePages and NextPage function.
type ListOrganizationalUnitsForParent ¶
type ListOrganizationalUnitsForParent interface { ListOrganizationalUnitsForParent( ctx context.Context, params *organizations.ListOrganizationalUnitsForParentInput, optFns ...func(*organizations.Options), ) ( *organizations.ListOrganizationalUnitsForParentOutput, error, ) }
--- ListOrganizationalUnitsForParent ---------------------------------------- ListOrganizationalUnitsForParent is an interface for the organizations ListOrganizationalUnitsForParent function in the AWS SDK that allows for mocking.
type ListOrganizationalUnitsForParentMock ¶
type ListOrganizationalUnitsForParentMock struct { ListOrganizationalUnitsForParentFunc func( ctx context.Context, params *organizations.ListOrganizationalUnitsForParentInput, optFns ...func(*organizations.Options), ) ( *organizations.ListOrganizationalUnitsForParentOutput, error, ) }
func (*ListOrganizationalUnitsForParentMock) ListOrganizationalUnitsForParent ¶
func (m *ListOrganizationalUnitsForParentMock) ListOrganizationalUnitsForParent( ctx context.Context, params *organizations.ListOrganizationalUnitsForParentInput, optFns ...func(*organizations.Options), ) ( *organizations.ListOrganizationalUnitsForParentOutput, error, )
type ListRoots ¶
type ListRoots interface { ListRoots( ctx context.Context, params *organizations.ListRootsInput, optFns ...func(*organizations.Options), ) ( *organizations.ListRootsOutput, error, ) }
--- ListRoots --------------------------------------------------------------- ListRoots is an interface for the ListRoots function from the organizations service in the AWS SDK that allows for mocking.
type ListRootsMock ¶
type ListRootsMock struct { ListRootsFunc func( ctx context.Context, params *organizations.ListRootsInput, optFns ...func(*organizations.Options), ) ( *organizations.ListRootsOutput, error, ) }
func (*ListRootsMock) ListRoots ¶
func (m *ListRootsMock) ListRoots( ctx context.Context, params *organizations.ListRootsInput, optFns ...func(*organizations.Options), ) ( *organizations.ListRootsOutput, error, )
type OU ¶
type OU struct { Id string `json:"id"` Name string `json:"name"` Children []*OU `json:"children"` Accounts []types.Account `json:"accounts"` }
--- OU ---------------------------------------------------------------------- OU is a struct that represents an OU in the AWS Organizations structure. It can be used to represent the entire structure or a substructure in the style of a tree.
func GenerateStructure ¶
GenerateStructure takes in an Organizations Client and returns a custom tree structure that contains all the information about the organization.
func (*OU) GetAccounts ¶
GetAccounts returns a list of the accounts in the OU.
func (*OU) RemoveSuspendedAccounts ¶ added in v0.1.2
removeSuspendedAccounts removes all suspended accounts from the OU tree.