5.0.0 • Published 3 years ago
@datafire/amazonaws_ram v5.0.0
@datafire/amazonaws_ram
Client library for AWS Resource Access Manager
Installation and Usage
npm install --save @datafire/amazonaws_ram
let amazonaws_ram = require('@datafire/amazonaws_ram').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
Description
Actions
AcceptResourceShareInvitation
amazonaws_ram.AcceptResourceShareInvitation({
"resourceShareInvitationArn": ""
}, context)
Input
- input
object
- clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - resourceShareInvitationArn required
string
: The Amazon Resource Name (ARN) of the invitation.
- clientToken
Output
AssociateResourceShare
amazonaws_ram.AssociateResourceShare({
"resourceShareArn": ""
}, context)
Input
- input
object
- clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - principals
array
: The principals.- items String
- resourceArns
array
: The Amazon Resource Names (ARN) of the resources.- items String
- resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- clientToken
Output
AssociateResourceSharePermission
amazonaws_ram.AssociateResourceSharePermission({
"resourceShareArn": "",
"permissionArn": ""
}, context)
Input
- input
object
- clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - permissionArn required
string
: The ARN of the AWS RAM permission to associate with the resource share. - replace
boolean
: Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current permission. - resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- clientToken
Output
CreateResourceShare
amazonaws_ram.CreateResourceShare({
"name": ""
}, context)
Input
- input
object
- tags
array
: One or more tags.- items Tag
- allowExternalPrincipals
boolean
: Indicates whether principals outside your AWS organization can be associated with a resource share. - clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - name required
string
: The name of the resource share. - permissionArns
array
: The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.- items String
- principals
array
: The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.- items String
- resourceArns
array
: The Amazon Resource Names (ARN) of the resources to associate with the resource share.- items String
- tags
Output
- output CreateResourceShareResponse
DeleteResourceShare
amazonaws_ram.DeleteResourceShare({
"resourceShareArn": ""
}, context)
Input
- input
object
- resourceShareArn required
string
- clientToken
string
- resourceShareArn required
Output
- output DeleteResourceShareResponse
DisassociateResourceShare
amazonaws_ram.DisassociateResourceShare({
"resourceShareArn": ""
}, context)
Input
- input
object
- clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - principals
array
: The principals.- items String
- resourceArns
array
: The Amazon Resource Names (ARNs) of the resources.- items String
- resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- clientToken
Output
DisassociateResourceSharePermission
amazonaws_ram.DisassociateResourceSharePermission({
"resourceShareArn": "",
"permissionArn": ""
}, context)
Input
- input
object
- clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - permissionArn required
string
: The ARN of the permission to disassociate from the resource share. - resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- clientToken
Output
EnableSharingWithAwsOrganization
amazonaws_ram.EnableSharingWithAwsOrganization({}, context)
Input
- input
object
Output
GetPermission
amazonaws_ram.GetPermission({
"permissionArn": ""
}, context)
Input
- input
object
- permissionArn required
string
: The ARN of the permission. - permissionVersion
integer
: The identifier for the version of the permission.
- permissionArn required
Output
- output GetPermissionResponse
GetResourcePolicies
amazonaws_ram.GetResourcePolicies({
"resourceArns": []
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - principal
string
: The principal. - resourceArns required
array
: The Amazon Resource Names (ARN) of the resources.- items String
- maxResults
Output
- output GetResourcePoliciesResponse
GetResourceShareAssociations
amazonaws_ram.GetResourceShareAssociations({
"associationType": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- associationStatus
string
(values: ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED): The association status. - associationType required
string
(values: PRINCIPAL, RESOURCE): The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share. - maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - principal
string
: The principal. You cannot specify this parameter if the association type is RESOURCE. - resourceArn
string
: The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL. - resourceShareArns
array
: The Amazon Resource Names (ARN) of the resource shares.- items String
- maxResults
Output
GetResourceShareInvitations
amazonaws_ram.GetResourceShareInvitations({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - resourceShareArns
array
: The Amazon Resource Names (ARN) of the resource shares.- items String
- resourceShareInvitationArns
array
: The Amazon Resource Names (ARN) of the invitations.- items String
- maxResults
Output
GetResourceShares
amazonaws_ram.GetResourceShares({
"resourceOwner": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - name
string
: The name of the resource share. - nextToken
string
: The token for the next page of results. - resourceOwner required
string
(values: SELF, OTHER-ACCOUNTS): The type of owner. - resourceShareArns
array
: The Amazon Resource Names (ARN) of the resource shares.- items String
- resourceShareStatus
string
(values: PENDING, ACTIVE, FAILED, DELETING, DELETED): The status of the resource share. - tagFilters
array
: One or more tag filters.- items TagFilter
- maxResults
Output
- output GetResourceSharesResponse
ListPendingInvitationResources
amazonaws_ram.ListPendingInvitationResources({
"resourceShareInvitationArn": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - resourceShareInvitationArn required
string
: The Amazon Resource Name (ARN) of the invitation.
- maxResults
Output
ListPermissions
amazonaws_ram.ListPermissions({}, context)
Input
- input
object
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - resourceType
string
: Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet.
- maxResults
Output
- output ListPermissionsResponse
ListPrincipals
amazonaws_ram.ListPrincipals({
"resourceOwner": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - principals
array
: The principals.- items String
- resourceArn
string
: The Amazon Resource Name (ARN) of the resource. - resourceOwner required
string
(values: SELF, OTHER-ACCOUNTS): The type of owner. - resourceShareArns
array
: The Amazon Resource Names (ARN) of the resource shares.- items String
- resourceType
string
: The resource type. Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule
- maxResults
Output
- output ListPrincipalsResponse
ListResources
amazonaws_ram.ListResources({
"resourceOwner": ""
}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - principal
string
: The principal. - resourceArns
array
: The Amazon Resource Names (ARN) of the resources.- items String
- resourceOwner required
string
(values: SELF, OTHER-ACCOUNTS): The type of owner. - resourceShareArns
array
: The Amazon Resource Names (ARN) of the resource shares.- items String
- resourceType
string
: The resource type. Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule
- maxResults
Output
- output ListResourcesResponse
ListResourceSharePermissions
amazonaws_ram.ListResourceSharePermissions({
"resourceShareArn": ""
}, context)
Input
- input
object
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results. - resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- maxResults
Output
ListResourceTypes
amazonaws_ram.ListResourceTypes({}, context)
Input
- input
object
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. - nextToken
string
: The token for the next page of results.
- maxResults
Output
- output ListResourceTypesResponse
PromoteResourceShareCreatedFromPolicy
amazonaws_ram.PromoteResourceShareCreatedFromPolicy({
"resourceShareArn": ""
}, context)
Input
- input
object
- resourceShareArn required
string
- resourceShareArn required
Output
RejectResourceShareInvitation
amazonaws_ram.RejectResourceShareInvitation({
"resourceShareInvitationArn": ""
}, context)
Input
- input
object
- clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - resourceShareInvitationArn required
string
: The Amazon Resource Name (ARN) of the invitation.
- clientToken
Output
TagResource
amazonaws_ram.TagResource({
"resourceShareArn": "",
"tags": []
}, context)
Input
- input
object
- tags required
array
: One or more tags.- items Tag
- resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- tags required
Output
- output TagResourceResponse
UntagResource
amazonaws_ram.UntagResource({
"resourceShareArn": "",
"tagKeys": []
}, context)
Input
- input
object
- resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share. - tagKeys required
array
: The tag keys of the tags to remove.- items TagKey
- resourceShareArn required
Output
- output UntagResourceResponse
UpdateResourceShare
amazonaws_ram.UpdateResourceShare({
"resourceShareArn": ""
}, context)
Input
- input
object
- allowExternalPrincipals
boolean
: Indicates whether principals outside your AWS organization can be associated with a resource share. - clientToken
string
: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - name
string
: The name of the resource share. - resourceShareArn required
string
: The Amazon Resource Name (ARN) of the resource share.
- allowExternalPrincipals
Output
- output UpdateResourceShareResponse
Definitions
AcceptResourceShareInvitationRequest
- AcceptResourceShareInvitationRequest
object
- clientToken
- resourceShareInvitationArn required
AcceptResourceShareInvitationResponse
- AcceptResourceShareInvitationResponse
object
- clientToken
- resourceShareInvitation
- invitationTimestamp
- receiverAccountId
- resourceShareArn
- resourceShareAssociations
- items ResourceShareAssociation
- resourceShareInvitationArn
- resourceShareName
- senderAccountId
- status
AssociateResourceSharePermissionRequest
- AssociateResourceSharePermissionRequest
object
- clientToken
- permissionArn required
- replace
- resourceShareArn required
AssociateResourceSharePermissionResponse
- AssociateResourceSharePermissionResponse
object
- clientToken
- returnValue
AssociateResourceShareRequest
- AssociateResourceShareRequest
object
AssociateResourceShareResponse
- AssociateResourceShareResponse
object
- clientToken
- resourceShareAssociations
- items ResourceShareAssociation
Boolean
- Boolean
boolean
CreateResourceShareRequest
- CreateResourceShareRequest
object
CreateResourceShareResponse
- CreateResourceShareResponse
object
- clientToken
- resourceShare
- tags
- items Tag
- allowExternalPrincipals
- creationTime
- featureSet
- lastUpdatedTime
- name
- owningAccountId
- resourceShareArn
- status
- statusMessage
- tags
DateTime
- DateTime
string
DeleteResourceShareRequest
- DeleteResourceShareRequest
object
DeleteResourceShareResponse
- DeleteResourceShareResponse
object
- clientToken
- returnValue
DisassociateResourceSharePermissionRequest
- DisassociateResourceSharePermissionRequest
object
- clientToken
- permissionArn required
- resourceShareArn required
DisassociateResourceSharePermissionResponse
- DisassociateResourceSharePermissionResponse
object
- clientToken
- returnValue
DisassociateResourceShareRequest
- DisassociateResourceShareRequest
object
DisassociateResourceShareResponse
- DisassociateResourceShareResponse
object
- clientToken
- resourceShareAssociations
- items ResourceShareAssociation
EnableSharingWithAwsOrganizationRequest
- EnableSharingWithAwsOrganizationRequest
object
EnableSharingWithAwsOrganizationResponse
- EnableSharingWithAwsOrganizationResponse
object
- returnValue
GetPermissionRequest
- GetPermissionRequest
object
- permissionArn required
- permissionVersion
GetPermissionResponse
- GetPermissionResponse
object
- permission
- arn
- creationTime
- defaultVersion
- lastUpdatedTime
- name
- permission
- resourceType
- version
- permission
GetResourcePoliciesRequest
- GetResourcePoliciesRequest
object
- maxResults
- nextToken
- principal
- resourceArns required
- items String
GetResourcePoliciesResponse
- GetResourcePoliciesResponse
object
- nextToken
- policies
- items Policy
GetResourceShareAssociationsRequest
- GetResourceShareAssociationsRequest
object
- associationStatus
- associationType required
- maxResults
- nextToken
- principal
- resourceArn
- resourceShareArns
- items String
GetResourceShareAssociationsResponse
- GetResourceShareAssociationsResponse
object
- nextToken
- resourceShareAssociations
- items ResourceShareAssociation
GetResourceShareInvitationsRequest
- GetResourceShareInvitationsRequest
object
GetResourceShareInvitationsResponse
- GetResourceShareInvitationsResponse
object
- nextToken
- resourceShareInvitations
- items ResourceShareInvitation
GetResourceSharesRequest
- GetResourceSharesRequest
object
GetResourceSharesResponse
- GetResourceSharesResponse
object
- nextToken
- resourceShares
- items ResourceShare
IdempotentParameterMismatchException
Integer
- Integer
integer
InvalidClientTokenException
InvalidMaxResultsException
InvalidNextTokenException
InvalidParameterException
InvalidResourceTypeException
InvalidStateTransitionException
ListPendingInvitationResourcesRequest
- ListPendingInvitationResourcesRequest
object
- maxResults
- nextToken
- resourceShareInvitationArn required
ListPendingInvitationResourcesResponse
- ListPendingInvitationResourcesResponse
object
- nextToken
- resources
- items Resource
ListPermissionsRequest
- ListPermissionsRequest
object
- maxResults
- nextToken
- resourceType
ListPermissionsResponse
- ListPermissionsResponse
object
- nextToken
- permissions
ListPrincipalsRequest
- ListPrincipalsRequest
object
ListPrincipalsResponse
- ListPrincipalsResponse
object
- nextToken
- principals
- items Principal
ListResourceSharePermissionsRequest
- ListResourceSharePermissionsRequest
object
- maxResults
- nextToken
- resourceShareArn required
ListResourceSharePermissionsResponse
- ListResourceSharePermissionsResponse
object
- nextToken
- permissions
ListResourceTypesRequest
- ListResourceTypesRequest
object
- maxResults
- nextToken
ListResourceTypesResponse
- ListResourceTypesResponse
object
- nextToken
- resourceTypes
ListResourcesRequest
- ListResourcesRequest
object
ListResourcesResponse
- ListResourcesResponse
object
- nextToken
- resources
- items Resource
MalformedArnException
MaxResults
- MaxResults
integer
MissingRequiredParameterException
OperationNotPermittedException
PermissionArnList
- PermissionArnList
array
- items String
Policy
- Policy
string
PolicyList
- PolicyList
array
- items Policy
Principal
- Principal
object
: Describes a principal for use with AWS Resource Access Manager.- creationTime
- external
- id
- lastUpdatedTime
- resourceShareArn
PrincipalArnOrIdList
- PrincipalArnOrIdList
array
- items String
PrincipalList
- PrincipalList
array
- items Principal
PromoteResourceShareCreatedFromPolicyRequest
- PromoteResourceShareCreatedFromPolicyRequest
object
PromoteResourceShareCreatedFromPolicyResponse
- PromoteResourceShareCreatedFromPolicyResponse
object
- returnValue
RejectResourceShareInvitationRequest
- RejectResourceShareInvitationRequest
object
- clientToken
- resourceShareInvitationArn required
RejectResourceShareInvitationResponse
- RejectResourceShareInvitationResponse
object
- clientToken
- resourceShareInvitation
- invitationTimestamp
- receiverAccountId
- resourceShareArn
- resourceShareAssociations
- items ResourceShareAssociation
- resourceShareInvitationArn
- resourceShareName
- senderAccountId
- status
Resource
- Resource
object
: Describes a resource associated with a resource share.- arn
- creationTime
- lastUpdatedTime
- resourceGroupArn
- resourceShareArn
- status
- statusMessage
- type
ResourceArnList
- ResourceArnList
array
- items String
ResourceArnNotFoundException
ResourceList
- ResourceList
array
- items Resource
ResourceOwner
- ResourceOwner
string
(values: SELF, OTHER-ACCOUNTS)
ResourceShare
- ResourceShare
object
: Describes a resource share.- tags
- items Tag
- allowExternalPrincipals
- creationTime
- featureSet
- lastUpdatedTime
- name
- owningAccountId
- resourceShareArn
- status
- statusMessage
- tags
ResourceShareArnList
- ResourceShareArnList
array
- items String
ResourceShareAssociation
- ResourceShareAssociation
object
: Describes an association with a resource share.- associatedEntity
- associationType
- creationTime
- external
- lastUpdatedTime
- resourceShareArn
- resourceShareName
- status
- statusMessage
ResourceShareAssociationList
- ResourceShareAssociationList
array
- items ResourceShareAssociation
ResourceShareAssociationStatus
- ResourceShareAssociationStatus
string
(values: ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED)
ResourceShareAssociationType
- ResourceShareAssociationType
string
(values: PRINCIPAL, RESOURCE)
ResourceShareFeatureSet
- ResourceShareFeatureSet
string
(values: CREATED_FROM_POLICY, PROMOTING_TO_STANDARD, STANDARD)
ResourceShareInvitation
- ResourceShareInvitation
object
: Describes an invitation to join a resource share.- invitationTimestamp
- receiverAccountId
- resourceShareArn
- resourceShareAssociations
- items ResourceShareAssociation
- resourceShareInvitationArn
- resourceShareName
- senderAccountId
- status
ResourceShareInvitationAlreadyAcceptedException
ResourceShareInvitationAlreadyRejectedException
ResourceShareInvitationArnList
- ResourceShareInvitationArnList
array
- items String
ResourceShareInvitationArnNotFoundException
ResourceShareInvitationExpiredException
ResourceShareInvitationList
- ResourceShareInvitationList
array
- items ResourceShareInvitation
ResourceShareInvitationStatus
- ResourceShareInvitationStatus
string
(values: PENDING, ACCEPTED, REJECTED, EXPIRED)
ResourceShareLimitExceededException
ResourceShareList
- ResourceShareList
array
- items ResourceShare
ResourceSharePermissionDetail
- ResourceSharePermissionDetail
object
: Information about an AWS RAM permission.- arn
- creationTime
- defaultVersion
- lastUpdatedTime
- name
- permission
- resourceType
- version
ResourceSharePermissionList
- ResourceSharePermissionList
array
ResourceSharePermissionSummary
- ResourceSharePermissionSummary
object
: Information about a permission that is associated with a resource share.- arn
- creationTime
- defaultVersion
- lastUpdatedTime
- name
- resourceType
- status
- version
ResourceShareStatus
- ResourceShareStatus
string
(values: PENDING, ACTIVE, FAILED, DELETING, DELETED)
ResourceStatus
- ResourceStatus
string
(values: AVAILABLE, ZONAL_RESOURCE_INACCESSIBLE, LIMIT_EXCEEDED, UNAVAILABLE, PENDING)
ServerInternalException
ServiceNameAndResourceType
- ServiceNameAndResourceType
object
: Information about the shareable resource types and the AWS services to which they belong.- resourceType
- serviceName
ServiceNameAndResourceTypeList
- ServiceNameAndResourceTypeList
array
ServiceUnavailableException
String
- String
string
Tag
- Tag
object
: Information about a tag.- key
- value
TagFilter
- TagFilter
object
: Used to filter information based on tags.- tagKey
- tagValues
- items TagValue
TagFilters
- TagFilters
array
- items TagFilter
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagLimitExceededException
TagList
- TagList
array
- items Tag
TagPolicyViolationException
TagResourceRequest
- TagResourceRequest
object
- tags required
- items Tag
- resourceShareArn required
- tags required
TagResourceResponse
- TagResourceResponse
object
TagValue
- TagValue
string
TagValueList
- TagValueList
array
- items TagValue
UnknownResourceException
UntagResourceRequest
- UntagResourceRequest
object
- resourceShareArn required
- tagKeys required
- items TagKey
UntagResourceResponse
- UntagResourceResponse
object
UpdateResourceShareRequest
- UpdateResourceShareRequest
object
- allowExternalPrincipals
- clientToken
- name
- resourceShareArn required
UpdateResourceShareResponse
- UpdateResourceShareResponse
object
- clientToken
- resourceShare
- tags
- items Tag
- allowExternalPrincipals
- creationTime
- featureSet
- lastUpdatedTime
- name
- owningAccountId
- resourceShareArn
- status
- statusMessage
- tags
5.0.0
3 years ago