package ram
import "github.com/aws/aws-sdk-go-v2/service/ram"
Package ram provides the API client, operations, and parameter types for AWS Resource Access Manager.
This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts. If you use Organizations to manage your accounts, then you share your resources with your organization or organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles an users. To learn more about RAM, see the following resources:
* Resource Access Manager product page (http://aws.amazon.com/ram)
* Resource Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/)
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AcceptResourceShareInvitationInput
- type AcceptResourceShareInvitationOutput
- type AssociateResourceShareInput
- type AssociateResourceShareOutput
- type AssociateResourceSharePermissionInput
- type AssociateResourceSharePermissionOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *AcceptResourceShareInvitationInput, optFns ...func(*Options)) (*AcceptResourceShareInvitationOutput, error)
- func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, optFns ...func(*Options)) (*AssociateResourceShareOutput, error)
- func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *AssociateResourceSharePermissionInput, optFns ...func(*Options)) (*AssociateResourceSharePermissionOutput, error)
- func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, optFns ...func(*Options)) (*CreateResourceShareOutput, error)
- func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, optFns ...func(*Options)) (*DeleteResourceShareOutput, error)
- func (c *Client) DisassociateResourceShare(ctx context.Context, params *DisassociateResourceShareInput, optFns ...func(*Options)) (*DisassociateResourceShareOutput, error)
- func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params *DisassociateResourceSharePermissionInput, optFns ...func(*Options)) (*DisassociateResourceSharePermissionOutput, error)
- func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, optFns ...func(*Options)) (*EnableSharingWithAwsOrganizationOutput, error)
- func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, optFns ...func(*Options)) (*GetPermissionOutput, error)
- func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
- func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetResourceShareAssociationsInput, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
- func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetResourceShareInvitationsInput, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
- func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
- func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
- func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error)
- func (c *Client) ListPrincipals(ctx context.Context, params *ListPrincipalsInput, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
- func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListResourceSharePermissionsInput, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
- func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesInput, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
- func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)
- func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, optFns ...func(*Options)) (*PromoteResourceShareCreatedFromPolicyOutput, error)
- func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *RejectResourceShareInvitationInput, optFns ...func(*Options)) (*RejectResourceShareInvitationOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResourceShareInput, optFns ...func(*Options)) (*UpdateResourceShareOutput, error)
- type CreateResourceShareInput
- type CreateResourceShareOutput
- type DeleteResourceShareInput
- type DeleteResourceShareOutput
- type DisassociateResourceShareInput
- type DisassociateResourceShareOutput
- type DisassociateResourceSharePermissionInput
- type DisassociateResourceSharePermissionOutput
- type EnableSharingWithAwsOrganizationInput
- type EnableSharingWithAwsOrganizationOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetPermissionInput
- type GetPermissionOutput
- type GetResourcePoliciesAPIClient
- type GetResourcePoliciesInput
- type GetResourcePoliciesOutput
- type GetResourcePoliciesPaginator
- func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator
- func (p *GetResourcePoliciesPaginator) HasMorePages() bool
- func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
- type GetResourcePoliciesPaginatorOptions
- type GetResourceShareAssociationsAPIClient
- type GetResourceShareAssociationsInput
- type GetResourceShareAssociationsOutput
- type GetResourceShareAssociationsPaginator
- func NewGetResourceShareAssociationsPaginator(client GetResourceShareAssociationsAPIClient, params *GetResourceShareAssociationsInput, optFns ...func(*GetResourceShareAssociationsPaginatorOptions)) *GetResourceShareAssociationsPaginator
- func (p *GetResourceShareAssociationsPaginator) HasMorePages() bool
- func (p *GetResourceShareAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
- type GetResourceShareAssociationsPaginatorOptions
- type GetResourceShareInvitationsAPIClient
- type GetResourceShareInvitationsInput
- type GetResourceShareInvitationsOutput
- type GetResourceShareInvitationsPaginator
- func NewGetResourceShareInvitationsPaginator(client GetResourceShareInvitationsAPIClient, params *GetResourceShareInvitationsInput, optFns ...func(*GetResourceShareInvitationsPaginatorOptions)) *GetResourceShareInvitationsPaginator
- func (p *GetResourceShareInvitationsPaginator) HasMorePages() bool
- func (p *GetResourceShareInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
- type GetResourceShareInvitationsPaginatorOptions
- type GetResourceSharesAPIClient
- type GetResourceSharesInput
- type GetResourceSharesOutput
- type GetResourceSharesPaginator
- func NewGetResourceSharesPaginator(client GetResourceSharesAPIClient, params *GetResourceSharesInput, optFns ...func(*GetResourceSharesPaginatorOptions)) *GetResourceSharesPaginator
- func (p *GetResourceSharesPaginator) HasMorePages() bool
- func (p *GetResourceSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
- type GetResourceSharesPaginatorOptions
- type HTTPClient
- type HTTPSignerV4
- type ListPendingInvitationResourcesAPIClient
- type ListPendingInvitationResourcesInput
- type ListPendingInvitationResourcesOutput
- type ListPendingInvitationResourcesPaginator
- func NewListPendingInvitationResourcesPaginator(client ListPendingInvitationResourcesAPIClient, params *ListPendingInvitationResourcesInput, optFns ...func(*ListPendingInvitationResourcesPaginatorOptions)) *ListPendingInvitationResourcesPaginator
- func (p *ListPendingInvitationResourcesPaginator) HasMorePages() bool
- func (p *ListPendingInvitationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
- type ListPendingInvitationResourcesPaginatorOptions
- type ListPermissionsAPIClient
- type ListPermissionsInput
- type ListPermissionsOutput
- type ListPermissionsPaginator
- func NewListPermissionsPaginator(client ListPermissionsAPIClient, params *ListPermissionsInput, optFns ...func(*ListPermissionsPaginatorOptions)) *ListPermissionsPaginator
- func (p *ListPermissionsPaginator) HasMorePages() bool
- func (p *ListPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionsOutput, error)
- type ListPermissionsPaginatorOptions
- type ListPrincipalsAPIClient
- type ListPrincipalsInput
- type ListPrincipalsOutput
- type ListPrincipalsPaginator
- func NewListPrincipalsPaginator(client ListPrincipalsAPIClient, params *ListPrincipalsInput, optFns ...func(*ListPrincipalsPaginatorOptions)) *ListPrincipalsPaginator
- func (p *ListPrincipalsPaginator) HasMorePages() bool
- func (p *ListPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
- type ListPrincipalsPaginatorOptions
- type ListResourceSharePermissionsAPIClient
- type ListResourceSharePermissionsInput
- type ListResourceSharePermissionsOutput
- type ListResourceSharePermissionsPaginator
- func NewListResourceSharePermissionsPaginator(client ListResourceSharePermissionsAPIClient, params *ListResourceSharePermissionsInput, optFns ...func(*ListResourceSharePermissionsPaginatorOptions)) *ListResourceSharePermissionsPaginator
- func (p *ListResourceSharePermissionsPaginator) HasMorePages() bool
- func (p *ListResourceSharePermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
- type ListResourceSharePermissionsPaginatorOptions
- type ListResourceTypesAPIClient
- type ListResourceTypesInput
- type ListResourceTypesOutput
- type ListResourceTypesPaginator
- func NewListResourceTypesPaginator(client ListResourceTypesAPIClient, params *ListResourceTypesInput, optFns ...func(*ListResourceTypesPaginatorOptions)) *ListResourceTypesPaginator
- func (p *ListResourceTypesPaginator) HasMorePages() bool
- func (p *ListResourceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
- type ListResourceTypesPaginatorOptions
- type ListResourcesAPIClient
- type ListResourcesInput
- type ListResourcesOutput
- type ListResourcesPaginator
- func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator
- func (p *ListResourcesPaginator) HasMorePages() bool
- func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)
- type ListResourcesPaginatorOptions
- type Options
- type PromoteResourceShareCreatedFromPolicyInput
- type PromoteResourceShareCreatedFromPolicyOutput
- type RejectResourceShareInvitationInput
- type RejectResourceShareInvitationOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateResourceShareInput
- type UpdateResourceShareOutput
Constants ¶
const ServiceAPIVersion = "2018-01-04"
const ServiceID = "RAM"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AcceptResourceShareInvitationInput ¶
type AcceptResourceShareInvitationInput struct { // The Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the invitation that you want to accept. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // contains filtered or unexported fields }
type AcceptResourceShareInvitationOutput ¶
type AcceptResourceShareInvitationOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // An object that contains information about the specified invitation. *types.ResourceShareInvitation // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type AssociateResourceShareInput ¶
type AssociateResourceShareInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share that you want to add principals or resources to. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // Specifies a list of principals to whom you want to the resource share. This can // be null if you want to add only resources. What the principals can do with the // resources in the share is determined by the RAM permissions that you associate // with the resource share. See AssociateResourceSharePermission. You can include // the following values: // // * An Amazon Web Services account ID, for example: // 123456789012 // // * An Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // * An ARN of an // organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // * // An ARN of an IAM role, for example: iam::123456789012:role/rolename // // * An ARN of // an IAM user, for example: iam::123456789012user/username // // Not all resource types // can be shared with IAM roles and users. For more information, see Sharing with // IAM roles and users // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. []string // Specifies a list of Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resources that you want to share. This can be null if you want to add only // principals. []string // contains filtered or unexported fields }
type AssociateResourceShareOutput ¶
type AssociateResourceShareOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // An array of objects that contain information about the associations. []types.ResourceShareAssociation // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type AssociateResourceSharePermissionInput ¶
type AssociateResourceSharePermissionInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the RAM permission to associate with the resource share. To find the ARN for a // permission, use either the ListPermissions operation or go to the Permissions // library (https://console.aws.amazon.com/ram/home#Permissions:) page in the RAM // console and then choose the name of the permission. The ARN is displayed on the // detail page. // // This member is required. *string // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share to which you want to add or replace permissions. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // Specifies the version of the RAM permission to associate with the resource // share. If you don't specify this parameter, the operation uses the version // designated as the default. *int32 // Specifies whether the specified permission should replace or add to the existing // permission associated with the resource share. Use true to replace the current // permissions. Use false to add the permission to the current permission. The // default value is false. A resource share can have only one permission per // resource type. If a resource share already has a permission for the specified // resource type and you don't set replace to true then the operation returns an // error. This helps prevent accidental overwriting of a permission. *bool // contains filtered or unexported fields }
type AssociateResourceSharePermissionOutput ¶
type AssociateResourceSharePermissionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // A return value of true indicates that the request succeeded. A value of false // indicates that the request failed. *bool // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Resource Access Manager.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AcceptResourceShareInvitation ¶
func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *AcceptResourceShareInvitationInput, optFns ...func(*Options)) (*AcceptResourceShareInvitationOutput, error)
Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.
func (*Client) AssociateResourceShare ¶
func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, optFns ...func(*Options)) (*AssociateResourceShareOutput, error)
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
func (*Client) AssociateResourceSharePermission ¶
func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *AssociateResourceSharePermissionInput, optFns ...func(*Options)) (*AssociateResourceSharePermissionOutput, error)
Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.
func (*Client) CreateResourceShare ¶
func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, optFns ...func(*Options)) (*CreateResourceShareOutput, error)
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals. Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.
func (*Client) DeleteResourceShare ¶
func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, optFns ...func(*Options)) (*DeleteResourceShareOutput, error)
Deletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources outside of the Amazon Web Services account that created them.
func (*Client) DisassociateResourceShare ¶
func (c *Client) DisassociateResourceShare(ctx context.Context, params *DisassociateResourceShareInput, optFns ...func(*Options)) (*DisassociateResourceShareOutput, error)
Disassociates the specified principals or resources from the specified resource share.
func (*Client) DisassociateResourceSharePermission ¶
func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params *DisassociateResourceSharePermissionInput, optFns ...func(*Options)) (*DisassociateResourceSharePermissionOutput, error)
Disassociates an RAM permission from a resource share. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
func (*Client) EnableSharingWithAwsOrganization ¶
func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, optFns ...func(*Options)) (*EnableSharingWithAwsOrganizationOutput, error)
Enables resource sharing within your organization in Organizations. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles. You must call this operation from an IAM user or role in the organization's management account.
func (*Client) GetPermission ¶
func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, optFns ...func(*Options)) (*GetPermissionOutput, error)
Gets the contents of an RAM permission in JSON format.
func (*Client) GetResourcePolicies ¶
func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
Retrieves the resource policies for the specified resources that you own and have shared.
func (*Client) GetResourceShareAssociations ¶
func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetResourceShareAssociationsInput, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
Retrieves the resource and principal associations for resource shares that you own.
func (*Client) GetResourceShareInvitations ¶
func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetResourceShareInvitationsInput, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
Retrieves details about invitations that you have received for resource shares.
func (*Client) GetResourceShares ¶
func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
Retrieves details about the resource shares that you own or that are shared with you.
func (*Client) ListPendingInvitationResources ¶
func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.
func (*Client) ListPermissions ¶
func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error)
Retrieves a list of available RAM permissions that you can use for the supported resource types.
func (*Client) ListPrincipals ¶
func (c *Client) ListPrincipals(ctx context.Context, params *ListPrincipalsInput, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
Lists the principals that you are sharing resources with or that are sharing resources with you.
func (*Client) ListResourceSharePermissions ¶
func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListResourceSharePermissionsInput, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
Lists the RAM permissions that are associated with a resource share.
func (*Client) ListResourceTypes ¶
func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesInput, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
Lists the resource types that can be shared by RAM.
func (*Client) ListResources ¶
func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)
Lists the resources that you added to a resource shares or the resources that are shared with you.
func (*Client) PromoteResourceShareCreatedFromPolicy ¶
func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, optFns ...func(*Options)) (*PromoteResourceShareCreatedFromPolicyOutput, error)
When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM. You can use this operation to promote the resource share to a full RAM resource share. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.
func (*Client) RejectResourceShareInvitation ¶
func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *RejectResourceShareInvitationInput, optFns ...func(*Options)) (*RejectResourceShareInvitationOutput, error)
Rejects an invitation to a resource share from another Amazon Web Services account.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the resource share.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the specified tag key and value pairs from the specified resource share.
func (*Client) UpdateResourceShare ¶
func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResourceShareInput, optFns ...func(*Options)) (*UpdateResourceShareOutput, error)
Modifies some of the properties of the specified resource share.
type CreateResourceShareInput ¶
type CreateResourceShareInput struct { // Specifies the name of the resource share. // // This member is required. *string // Specifies whether principals outside your organization in Organizations can be // associated with a resource share. A value of true lets you share with individual // Amazon Web Services accounts that are not in your organization. A value of false // only has meaning if your account is a member of an Amazon Web Services // Organization. The default value is true. *bool // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // Specifies the Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the RAM permission to associate with the resource share. If you do not specify // an ARN for the permission, RAM automatically attaches the default version of the // permission for each resource type. You can associate only one permission with // each resource type included in the resource share. []string // Specifies a list of one or more principals to associate with the resource share. // You can include the following values: // // * An Amazon Web Services account ID, for // example: 123456789012 // // * An Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // * An ARN of an // organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // * // An ARN of an IAM role, for example: iam::123456789012:role/rolename // // * An ARN of // an IAM user, for example: iam::123456789012user/username // // Not all resource types // can be shared with IAM roles and users. For more information, see Sharing with // IAM roles and users // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. []string // Specifies a list of one or more ARNs of the resources to associate with the // resource share. []string // Specifies one or more tags to attach to the resource share itself. It doesn't // attach the tags to the resources associated with the resource share. []types.Tag // contains filtered or unexported fields }
type CreateResourceShareOutput ¶
type CreateResourceShareOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // An object with information about the new resource share. *types.ResourceShare // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type DeleteResourceShareInput ¶
type DeleteResourceShareInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share to delete. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // contains filtered or unexported fields }
type DeleteResourceShareOutput ¶
type DeleteResourceShareOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // A return value of true indicates that the request succeeded. A value of false // indicates that the request failed. *bool // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type DisassociateResourceShareInput ¶
type DisassociateResourceShareInput struct { // Specifies Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share that you want to remove resources from. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // Specifies a list of one or more principals that no longer are to have access to // the resources in this resource share. You can include the following values: // // * // An Amazon Web Services account ID, for example: 123456789012 // // * An Amazon // Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // * An ARN of an // organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // * // An ARN of an IAM role, for example: iam::123456789012:role/rolename // // * An ARN of // an IAM user, for example: iam::123456789012user/username // // Not all resource types // can be shared with IAM roles and users. For more information, see Sharing with // IAM roles and users // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. []string // Specifies a list of Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for // one or more resources that you want to remove from the resource share. After the // operation runs, these resources are no longer shared with principals outside of // the Amazon Web Services account that created the resources. []string // contains filtered or unexported fields }
type DisassociateResourceShareOutput ¶
type DisassociateResourceShareOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // An array of objects that contain information about the updated associations for // this resource share. []types.ResourceShareAssociation // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type DisassociateResourceSharePermissionInput ¶
type DisassociateResourceSharePermissionInput struct { // The Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the permission to disassociate from the resource share. Changes to permissions // take effect immediately. // // This member is required. *string // The Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share from which you want to disassociate a permission. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // contains filtered or unexported fields }
type DisassociateResourceSharePermissionOutput ¶
type DisassociateResourceSharePermissionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // A return value of true indicates that the request succeeded. A value of false // indicates that the request failed. *bool // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type EnableSharingWithAwsOrganizationInput ¶
type EnableSharingWithAwsOrganizationInput struct {
// contains filtered or unexported fields
}
type EnableSharingWithAwsOrganizationOutput ¶
type EnableSharingWithAwsOrganizationOutput struct { // A return value of true indicates that the request succeeded. A value of false // indicates that the request failed. ReturnValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetPermissionInput ¶
type GetPermissionInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the permission whose contents you want to retrieve. To find the ARN for a // permission, use either the ListPermissions operation or go to the Permissions // library (https://console.aws.amazon.com/ram/home#Permissions:) page in the RAM // console and then choose the name of the permission. The ARN is displayed on the // detail page. // // This member is required. PermissionArn *string // Specifies identifier for the version of the RAM permission to retrieve. If you // don't specify this parameter, the operation retrieves the default version. PermissionVersion *int32 // contains filtered or unexported fields }
type GetPermissionOutput ¶
type GetPermissionOutput struct { // An object that contains information about the permission. Permission *types.ResourceSharePermissionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePoliciesAPIClient ¶
type GetResourcePoliciesAPIClient interface { GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error) }
GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies operation.
type GetResourcePoliciesInput ¶
type GetResourcePoliciesInput struct { // Specifies the Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resources whose policies you want to retrieve. // // This member is required. ResourceArns []string // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies the principal. Principal *string // contains filtered or unexported fields }
type GetResourcePoliciesOutput ¶
type GetResourcePoliciesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. NextToken *string // An array of resource policy documents in JSON format. Policies []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePoliciesPaginator ¶
type GetResourcePoliciesPaginator struct {
// contains filtered or unexported fields
}
GetResourcePoliciesPaginator is a paginator for GetResourcePolicies
func NewGetResourcePoliciesPaginator ¶
func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator
NewGetResourcePoliciesPaginator returns a new GetResourcePoliciesPaginator
func (*GetResourcePoliciesPaginator) HasMorePages ¶
func (p *GetResourcePoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourcePoliciesPaginator) NextPage ¶
func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
NextPage retrieves the next GetResourcePolicies page.
type GetResourcePoliciesPaginatorOptions ¶
type GetResourcePoliciesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetResourcePoliciesPaginatorOptions is the paginator options for GetResourcePolicies
type GetResourceShareAssociationsAPIClient ¶
type GetResourceShareAssociationsAPIClient interface { context.Context, *GetResourceShareAssociationsInput, ...func(*Options)) (*GetResourceShareAssociationsOutput, error) }(
GetResourceShareAssociationsAPIClient is a client that implements the GetResourceShareAssociations operation.
type GetResourceShareAssociationsInput ¶
type GetResourceShareAssociationsInput struct { // Specifies whether you want to retrieve the associations that involve a specified // resource or principal. // // * PRINCIPAL – list the principals that are associated // with the specified resource share. // // * RESOURCE – list the resources that are // associated with the specified resource share. // // This member is required. types.ResourceShareAssociationType // Specifies that you want to retrieve only associations with this status. types.ResourceShareAssociationStatus // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. *string // Specifies the ID of the principal whose resource shares you want to retrieve. // This can be an Amazon Web Services account ID, an organization ID, an // organizational unit ID, or the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // an individual IAM user or role. You cannot specify this parameter if the // association type is RESOURCE. *string // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource whose resource shares you want to retrieve. You cannot specify this // parameter if the association type is PRINCIPAL. *string // Specifies a list of Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share whose associations you want to retrieve. []string // contains filtered or unexported fields }
type GetResourceShareAssociationsOutput ¶
type GetResourceShareAssociationsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. *string // An array of objects that contain the details about the associations. []types.ResourceShareAssociation // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type GetResourceShareAssociationsPaginator ¶
type GetResourceShareAssociationsPaginator struct {
// contains filtered or unexported fields
}
GetResourceShareAssociationsPaginator is a paginator for GetResourceShareAssociations
func NewGetResourceShareAssociationsPaginator ¶
func NewGetResourceShareAssociationsPaginator(client GetResourceShareAssociationsAPIClient, params *GetResourceShareAssociationsInput, optFns ...func(*GetResourceShareAssociationsPaginatorOptions)) *GetResourceShareAssociationsPaginator
NewGetResourceShareAssociationsPaginator returns a new GetResourceShareAssociationsPaginator
func (*GetResourceShareAssociationsPaginator) HasMorePages ¶
func (p *GetResourceShareAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourceShareAssociationsPaginator) NextPage ¶
func (p *GetResourceShareAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
NextPage retrieves the next GetResourceShareAssociations page.
type GetResourceShareAssociationsPaginatorOptions ¶
type GetResourceShareAssociationsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. bool }
GetResourceShareAssociationsPaginatorOptions is the paginator options for GetResourceShareAssociations
type GetResourceShareInvitationsAPIClient ¶
type GetResourceShareInvitationsAPIClient interface { context.Context, *GetResourceShareInvitationsInput, ...func(*Options)) (*GetResourceShareInvitationsOutput, error) }(
GetResourceShareInvitationsAPIClient is a client that implements the GetResourceShareInvitations operation.
type GetResourceShareInvitationsInput ¶
type GetResourceShareInvitationsInput struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. *string // Specifies that you want details about invitations only for the resource shares // described by this list of Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) []string // Specifies the Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share invitations you want information about. []string // contains filtered or unexported fields }
type GetResourceShareInvitationsOutput ¶
type GetResourceShareInvitationsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. *string // An array of objects that contain the details about the invitations. []types.ResourceShareInvitation // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type GetResourceShareInvitationsPaginator ¶
type GetResourceShareInvitationsPaginator struct {
// contains filtered or unexported fields
}
GetResourceShareInvitationsPaginator is a paginator for GetResourceShareInvitations
func NewGetResourceShareInvitationsPaginator ¶
func NewGetResourceShareInvitationsPaginator(client GetResourceShareInvitationsAPIClient, params *GetResourceShareInvitationsInput, optFns ...func(*GetResourceShareInvitationsPaginatorOptions)) *GetResourceShareInvitationsPaginator
NewGetResourceShareInvitationsPaginator returns a new GetResourceShareInvitationsPaginator
func (*GetResourceShareInvitationsPaginator) HasMorePages ¶
func (p *GetResourceShareInvitationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourceShareInvitationsPaginator) NextPage ¶
func (p *GetResourceShareInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
NextPage retrieves the next GetResourceShareInvitations page.
type GetResourceShareInvitationsPaginatorOptions ¶
type GetResourceShareInvitationsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. bool }
GetResourceShareInvitationsPaginatorOptions is the paginator options for GetResourceShareInvitations
type GetResourceSharesAPIClient ¶
type GetResourceSharesAPIClient interface { context.Context, *GetResourceSharesInput, ...func(*Options)) (*GetResourceSharesOutput, error) }(
GetResourceSharesAPIClient is a client that implements the GetResourceShares operation.
type GetResourceSharesInput ¶
type GetResourceSharesInput struct { // Specifies that you want to retrieve details of only those resource shares that // match the following: // // * SELF – resources that you are sharing // // * OTHER-ACCOUNTS // – resources that other accounts share with you // // This member is required. types.ResourceOwner // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. *int32 // Specifies the name of an individual resource share that you want to retrieve // details about. *string // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. *string // Specifies that you want to retrieve details of only those resource shares that // use the RAM permission with this Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). *string // Specifies the Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // individual resource shares that you want information about. []string // Specifies that you want to retrieve details of only those resource shares that // have this status. types.ResourceShareStatus // Specifies that you want to retrieve details of only those resource shares that // match the specified tag keys and values. []types.TagFilter // contains filtered or unexported fields }
type GetResourceSharesOutput ¶
type GetResourceSharesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. *string // An array of objects that contain the information about the resource shares. []types.ResourceShare // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type GetResourceSharesPaginator ¶
type GetResourceSharesPaginator struct {
// contains filtered or unexported fields
}
GetResourceSharesPaginator is a paginator for GetResourceShares
func NewGetResourceSharesPaginator ¶
func NewGetResourceSharesPaginator(client GetResourceSharesAPIClient, params *GetResourceSharesInput, optFns ...func(*GetResourceSharesPaginatorOptions)) *GetResourceSharesPaginator
NewGetResourceSharesPaginator returns a new GetResourceSharesPaginator
func (*GetResourceSharesPaginator) HasMorePages ¶
func (p *GetResourceSharesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourceSharesPaginator) NextPage ¶
func (p *GetResourceSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
NextPage retrieves the next GetResourceShares page.
type GetResourceSharesPaginatorOptions ¶
type GetResourceSharesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. bool }
GetResourceSharesPaginatorOptions is the paginator options for GetResourceShares
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type ListPendingInvitationResourcesAPIClient ¶
type ListPendingInvitationResourcesAPIClient interface { ListPendingInvitationResources(context.Context, *ListPendingInvitationResourcesInput, ...func(*Options)) (*ListPendingInvitationResourcesOutput, error) }
ListPendingInvitationResourcesAPIClient is a client that implements the ListPendingInvitationResources operation.
type ListPendingInvitationResourcesInput ¶
type ListPendingInvitationResourcesInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the invitation. You can use GetResourceShareInvitations to find the ARN of the // invitation. // // This member is required. *string // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want the results to include only resources that have the // specified scope. // // * ALL – the results include both global and regional resources // or resource types. // // * GLOBAL – the results include only global resources or // resource types. // // * REGIONAL – the results include only regional resources or // resource types. // // The default value is ALL. ResourceRegionScope types.ResourceRegionScopeFilter // contains filtered or unexported fields }
type ListPendingInvitationResourcesOutput ¶
type ListPendingInvitationResourcesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. NextToken *string // An array of objects that contain the information about the resources included // the specified resource share. Resources []types.Resource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPendingInvitationResourcesPaginator ¶
type ListPendingInvitationResourcesPaginator struct {
// contains filtered or unexported fields
}
ListPendingInvitationResourcesPaginator is a paginator for ListPendingInvitationResources
func NewListPendingInvitationResourcesPaginator ¶
func NewListPendingInvitationResourcesPaginator(client ListPendingInvitationResourcesAPIClient, params *ListPendingInvitationResourcesInput, optFns ...func(*ListPendingInvitationResourcesPaginatorOptions)) *ListPendingInvitationResourcesPaginator
NewListPendingInvitationResourcesPaginator returns a new ListPendingInvitationResourcesPaginator
func (*ListPendingInvitationResourcesPaginator) HasMorePages ¶
func (p *ListPendingInvitationResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPendingInvitationResourcesPaginator) NextPage ¶
func (p *ListPendingInvitationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
NextPage retrieves the next ListPendingInvitationResources page.
type ListPendingInvitationResourcesPaginatorOptions ¶
type ListPendingInvitationResourcesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPendingInvitationResourcesPaginatorOptions is the paginator options for ListPendingInvitationResources
type ListPermissionsAPIClient ¶
type ListPermissionsAPIClient interface { ListPermissions(context.Context, *ListPermissionsInput, ...func(*Options)) (*ListPermissionsOutput, error) }
ListPermissionsAPIClient is a client that implements the ListPermissions operation.
type ListPermissionsInput ¶
type ListPermissionsInput struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to list permissions for only the specified resource // type. For example, to list only permissions that apply to EC2 subnets, specify // ec2:Subnet. You can use the ListResourceTypes operation to get the specific // string required. ResourceType *string // contains filtered or unexported fields }
type ListPermissionsOutput ¶
type ListPermissionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. NextToken *string // An array of objects with information about the permissions. Permissions []types.ResourceSharePermissionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPermissionsPaginator ¶
type ListPermissionsPaginator struct {
// contains filtered or unexported fields
}
ListPermissionsPaginator is a paginator for ListPermissions
func NewListPermissionsPaginator ¶
func NewListPermissionsPaginator(client ListPermissionsAPIClient, params *ListPermissionsInput, optFns ...func(*ListPermissionsPaginatorOptions)) *ListPermissionsPaginator
NewListPermissionsPaginator returns a new ListPermissionsPaginator
func (*ListPermissionsPaginator) HasMorePages ¶
func (p *ListPermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPermissionsPaginator) NextPage ¶
func (p *ListPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionsOutput, error)
NextPage retrieves the next ListPermissions page.
type ListPermissionsPaginatorOptions ¶
type ListPermissionsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPermissionsPaginatorOptions is the paginator options for ListPermissions
type ListPrincipalsAPIClient ¶
type ListPrincipalsAPIClient interface { ListPrincipals(context.Context, *ListPrincipalsInput, ...func(*Options)) (*ListPrincipalsOutput, error) }
ListPrincipalsAPIClient is a client that implements the ListPrincipals operation.
type ListPrincipalsInput ¶
type ListPrincipalsInput struct { // Specifies that you want to list information for only resource shares that match // the following: // // * SELF – resources that you are sharing // // * OTHER-ACCOUNTS – // resources that other accounts share with you // // This member is required. ResourceOwner types.ResourceOwner // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to list information for only the listed principals. You // can include the following values: // // * An Amazon Web Services account ID, for // example: 123456789012 // // * An Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // * An ARN of an // organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // * // An ARN of an IAM role, for example: iam::123456789012:role/rolename // // * An ARN of // an IAM user, for example: iam::123456789012user/username // // Not all resource types // can be shared with IAM roles and users. For more information, see Sharing with // IAM roles and users // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. Principals []string // Specifies that you want to list principal information for the resource share // with the specified Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). ResourceArn *string // Specifies that you want to list information for only principals associated with // the resource shares specified by a list the Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). []string // Specifies that you want to list information for only principals associated with // resource shares that include the specified resource type. For a list of valid // values, query the ListResourceTypes operation. ResourceType *string // contains filtered or unexported fields }
type ListPrincipalsOutput ¶
type ListPrincipalsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. NextToken *string // An array of objects that contain the details about the principals. Principals []types.Principal // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPrincipalsPaginator ¶
type ListPrincipalsPaginator struct {
// contains filtered or unexported fields
}
ListPrincipalsPaginator is a paginator for ListPrincipals
func NewListPrincipalsPaginator ¶
func NewListPrincipalsPaginator(client ListPrincipalsAPIClient, params *ListPrincipalsInput, optFns ...func(*ListPrincipalsPaginatorOptions)) *ListPrincipalsPaginator
NewListPrincipalsPaginator returns a new ListPrincipalsPaginator
func (*ListPrincipalsPaginator) HasMorePages ¶
func (p *ListPrincipalsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPrincipalsPaginator) NextPage ¶
func (p *ListPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
NextPage retrieves the next ListPrincipals page.
type ListPrincipalsPaginatorOptions ¶
type ListPrincipalsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPrincipalsPaginatorOptions is the paginator options for ListPrincipals
type ListResourceSharePermissionsAPIClient ¶
type ListResourceSharePermissionsAPIClient interface { context.Context, *ListResourceSharePermissionsInput, ...func(*Options)) (*ListResourceSharePermissionsOutput, error) }(
ListResourceSharePermissionsAPIClient is a client that implements the ListResourceSharePermissions operation.
type ListResourceSharePermissionsInput ¶
type ListResourceSharePermissionsInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share for which you want to retrieve the associated permissions. // // This member is required. *string // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. *string // contains filtered or unexported fields }
type ListResourceSharePermissionsOutput ¶
type ListResourceSharePermissionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. *string // An array of objects that describe the permissions associated with the resource // share. []types.ResourceSharePermissionSummary // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type ListResourceSharePermissionsPaginator ¶
type ListResourceSharePermissionsPaginator struct {
// contains filtered or unexported fields
}
ListResourceSharePermissionsPaginator is a paginator for ListResourceSharePermissions
func NewListResourceSharePermissionsPaginator ¶
func NewListResourceSharePermissionsPaginator(client ListResourceSharePermissionsAPIClient, params *ListResourceSharePermissionsInput, optFns ...func(*ListResourceSharePermissionsPaginatorOptions)) *ListResourceSharePermissionsPaginator
NewListResourceSharePermissionsPaginator returns a new ListResourceSharePermissionsPaginator
func (*ListResourceSharePermissionsPaginator) HasMorePages ¶
func (p *ListResourceSharePermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourceSharePermissionsPaginator) NextPage ¶
func (p *ListResourceSharePermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
NextPage retrieves the next ListResourceSharePermissions page.
type ListResourceSharePermissionsPaginatorOptions ¶
type ListResourceSharePermissionsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. bool }
ListResourceSharePermissionsPaginatorOptions is the paginator options for ListResourceSharePermissions
type ListResourceTypesAPIClient ¶
type ListResourceTypesAPIClient interface { ListResourceTypes(context.Context, *ListResourceTypesInput, ...func(*Options)) (*ListResourceTypesOutput, error) }
ListResourceTypesAPIClient is a client that implements the ListResourceTypes operation.
type ListResourceTypesInput ¶
type ListResourceTypesInput struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want the results to include only resources that have the // specified scope. // // * ALL – the results include both global and regional resources // or resource types. // // * GLOBAL – the results include only global resources or // resource types. // // * REGIONAL – the results include only regional resources or // resource types. // // The default value is ALL. ResourceRegionScope types.ResourceRegionScopeFilter // contains filtered or unexported fields }
type ListResourceTypesOutput ¶
type ListResourceTypesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. NextToken *string // An array of objects that contain information about the resource types that can // be shared using RAM. ResourceTypes []types.ServiceNameAndResourceType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourceTypesPaginator ¶
type ListResourceTypesPaginator struct {
// contains filtered or unexported fields
}
ListResourceTypesPaginator is a paginator for ListResourceTypes
func NewListResourceTypesPaginator ¶
func NewListResourceTypesPaginator(client ListResourceTypesAPIClient, params *ListResourceTypesInput, optFns ...func(*ListResourceTypesPaginatorOptions)) *ListResourceTypesPaginator
NewListResourceTypesPaginator returns a new ListResourceTypesPaginator
func (*ListResourceTypesPaginator) HasMorePages ¶
func (p *ListResourceTypesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourceTypesPaginator) NextPage ¶
func (p *ListResourceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
NextPage retrieves the next ListResourceTypes page.
type ListResourceTypesPaginatorOptions ¶
type ListResourceTypesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResourceTypesPaginatorOptions is the paginator options for ListResourceTypes
type ListResourcesAPIClient ¶
type ListResourcesAPIClient interface { ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error) }
ListResourcesAPIClient is a client that implements the ListResources operation.
type ListResourcesInput ¶
type ListResourcesInput struct { // Specifies that you want to list only the resource shares that match the // following: // // * SELF – resources that you are sharing // // * OTHER-ACCOUNTS – // resources that other accounts share with you // // This member is required. ResourceOwner types.ResourceOwner // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to list only the resource shares that are associated // with the specified principal. Principal *string // Specifies that you want to list only the resource shares that include resources // with the specified Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). ResourceArns []string // Specifies that you want the results to include only resources that have the // specified scope. // // * ALL – the results include both global and regional resources // or resource types. // // * GLOBAL – the results include only global resources or // resource types. // // * REGIONAL – the results include only regional resources or // resource types. // // The default value is ALL. ResourceRegionScope types.ResourceRegionScopeFilter // Specifies that you want to list only resources in the resource shares identified // by the specified Amazon Resource Names (ARNs) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). []string // Specifies that you want to list only the resource shares that include resources // of the specified resource type. For valid values, query the ListResourceTypes // operation. ResourceType *string // contains filtered or unexported fields }
type ListResourcesOutput ¶
type ListResourcesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null. This // indicates that this is the last page of results. NextToken *string // An array of objects that contain information about the resources. Resources []types.Resource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourcesPaginator ¶
type ListResourcesPaginator struct {
// contains filtered or unexported fields
}
ListResourcesPaginator is a paginator for ListResources
func NewListResourcesPaginator ¶
func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator
NewListResourcesPaginator returns a new ListResourcesPaginator
func (*ListResourcesPaginator) HasMorePages ¶
func (p *ListResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourcesPaginator) NextPage ¶
func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)
NextPage retrieves the next ListResources page.
type ListResourcesPaginatorOptions ¶
type ListResourcesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResourcesPaginatorOptions is the paginator options for ListResources
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PromoteResourceShareCreatedFromPolicyInput ¶
type PromoteResourceShareCreatedFromPolicyInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share to promote. // // This member is required. *string // contains filtered or unexported fields }
type PromoteResourceShareCreatedFromPolicyOutput ¶
type PromoteResourceShareCreatedFromPolicyOutput struct { // A return value of true indicates that the request succeeded. A value of false // indicates that the request failed. *bool // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type RejectResourceShareInvitationInput ¶
type RejectResourceShareInvitationInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the invitation that you want to reject. // // This member is required. *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // contains filtered or unexported fields }
type RejectResourceShareInvitationOutput ¶
type RejectResourceShareInvitationOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // An object that contains the details about the rejected invitation. *types.ResourceShareInvitation // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share that you want to add tags to. // // This member is required. *string // A list of one or more tag key and value pairs. The tag key must be present and // not be an empty string. The tag value must be present but can be an empty // string. // // This member is required. Tags []types.Tag // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share that you want to remove tags from. The tags are removed from // the resource share, not the resources in the resource share. // // This member is required. *string // Specifies a list of one or more tag keys that you want to remove. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateResourceShareInput ¶
type UpdateResourceShareInput struct { // Specifies the Amazon Resoure Name (ARN) // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource share that you want to modify. // // This member is required. *string // Specifies whether principals outside your organization in Organizations can be // associated with a resource share. *bool // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a UUID type of value. // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide // this value, then Amazon Web Services generates a random one for you. *string // If specified, the new name that you want to attach to the resource share. *string // contains filtered or unexported fields }
type UpdateResourceShareOutput ¶
type UpdateResourceShareOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. *string // Information about the resource share. *types.ResourceShare // Metadata pertaining to the operation's result. middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
api_client.go api_op_AcceptResourceShareInvitation.go api_op_AssociateResourceShare.go api_op_AssociateResourceSharePermission.go api_op_CreateResourceShare.go api_op_DeleteResourceShare.go api_op_DisassociateResourceShare.go api_op_DisassociateResourceSharePermission.go api_op_EnableSharingWithAwsOrganization.go api_op_GetPermission.go api_op_GetResourcePolicies.go api_op_GetResourceShareAssociations.go api_op_GetResourceShareInvitations.go api_op_GetResourceShares.go api_op_ListPendingInvitationResources.go api_op_ListPermissions.go api_op_ListPrincipals.go api_op_ListResourceSharePermissions.go api_op_ListResourceTypes.go api_op_ListResources.go api_op_PromoteResourceShareCreatedFromPolicy.go api_op_RejectResourceShareInvitation.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateResourceShare.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.11.0
- Published
- Dec 21, 2021
- Platform
- js/wasm
- Imports
- 29 packages
- Last checked
- now –
Tools for package owners.