AWS.Tools.AppRegistry.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AppRegistry</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.AddSCARResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified resource. <para> Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value. </para><para> This operation returns an empty response if the call was successful. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.AddSCARResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon resource name (ARN) that specifies the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.AddSCARResourceTagCmdlet.Tag"> <summary> <para> <para>The new or modified tags for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.AddSCARResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.AddSCARResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.AddSCARResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationCmdlet"> <summary> Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a <c>ResourceNotFoundException</c> is thrown, avoiding the ABA addressing problem. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.GetApplicationResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.GetApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Application parameter. The -PassThru parameter is deprecated, use -Select '^Application' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationListCmdlet"> <summary> Retrieves a list of all of your applications. Results are paginated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationListCmdlet.MaxResult"> <summary> <para> <para>The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationListCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Applications'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.ListApplicationsResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.ListApplicationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedAttributeGroupListCmdlet"> <summary> Lists all attribute groups that are associated with specified application. Results are paginated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedAttributeGroupListCmdlet.Application"> <summary> <para> <para>The name or ID of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedAttributeGroupListCmdlet.MaxResult"> <summary> <para> <para>The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedAttributeGroupListCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedAttributeGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.ListAssociatedAttributeGroupsResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.ListAssociatedAttributeGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedAttributeGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Application parameter. The -PassThru parameter is deprecated, use -Select '^Application' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet"> <summary> Gets the resource associated with the application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.Resource"> <summary> <para> <para>The name or ID of the resource associated with the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.ResourceTagStatus"> <summary> <para> <para> States whether an application tag is applied, not applied, in the process of being applied, or skipped. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.ResourceType"> <summary> <para> <para>The type of resource associated with the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.NextToken"> <summary> <para> <para> A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.GetAssociatedResourceResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.GetAssociatedResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceListCmdlet"> <summary> Lists all of the resources that are associated with the specified application. Results are paginated. <note><para> If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceListCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceListCmdlet.MaxResult"> <summary> <para> <para>The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceListCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.ListAssociatedResourcesResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.ListAssociatedResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAssociatedResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Application parameter. The -PassThru parameter is deprecated, use -Select '^Application' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupCmdlet"> <summary> Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupCmdlet.AttributeGroup"> <summary> <para> <para> The name, ID, or ARN of the attribute group that holds the attributes to describe the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.GetAttributeGroupResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.GetAttributeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttributeGroup parameter. The -PassThru parameter is deprecated, use -Select '^AttributeGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupListCmdlet"> <summary> Lists all attribute groups which you have access to. Results are paginated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupListCmdlet.MaxResult"> <summary> <para> <para>The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupListCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.ListAttributeGroupsResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.ListAttributeGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupsForApplicationListCmdlet"> <summary> Lists the details of all attribute groups associated with a specific application. The results display in pages. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupsForApplicationListCmdlet.Application"> <summary> <para> <para>The name or ID of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupsForApplicationListCmdlet.MaxResult"> <summary> <para> <para>The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupsForApplicationListCmdlet.NextToken"> <summary> <para> <para>This token retrieves the next page of results after a previous API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupsForApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeGroupsDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.ListAttributeGroupsForApplicationResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.ListAttributeGroupsForApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARAttributeGroupsForApplicationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Application parameter. The -PassThru parameter is deprecated, use -Select '^Application' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARConfigurationCmdlet"> <summary> Retrieves a <c>TagKey</c> configuration from an account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.GetConfigurationResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.GetConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.GetSCARResourceTagCmdlet"> <summary> Lists all of the tags on the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon resource name (ARN) that specifies the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.GetSCARResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet"> <summary> Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.Description"> <summary> <para> <para>The description of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.Name"> <summary> <para> <para>The name of the application. The name must be unique in the region in which you are creating the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.Tag"> <summary> <para> <para>Key-value pairs you can use to associate with the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Application'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.CreateApplicationResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.CreateApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet"> <summary> Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.Attribute"> <summary> <para> <para>A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.Description"> <summary> <para> <para>The description of the attribute group that the user provides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.Name"> <summary> <para> <para>The name of the attribute group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.Tag"> <summary> <para> <para>Key-value pairs you can use to associate with the attribute group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.CreateAttributeGroupResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.CreateAttributeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.NewSCARAttributeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARAttributeGroupCmdlet"> <summary> Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARAttributeGroupCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARAttributeGroupCmdlet.AttributeGroup"> <summary> <para> <para> The name, ID, or ARN of the attribute group that holds the attributes to describe the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARAttributeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.AssociateAttributeGroupResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.AssociateAttributeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARAttributeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet"> <summary> Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name. <para><b>Minimum permissions</b></para><para> You must have the following permissions to associate a resource using the <c>OPTIONS</c> parameter set to <c>APPLY_APPLICATION_TAG</c>. </para><ul><li><para><c>tag:GetResources</c></para></li><li><para><c>tag:TagResources</c></para></li></ul><para> You must also have these additional permissions if you don't use the <c>AWSServiceCatalogAppRegistryFullAccess</c> policy. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html">AWSServiceCatalogAppRegistryFullAccess</a> in the AppRegistry Administrator Guide. </para><ul><li><para><c>resource-groups:AssociateResource</c></para></li><li><para><c>cloudformation:UpdateStack</c></para></li><li><para><c>cloudformation:DescribeStacks</c></para></li></ul><note><para> In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html">TagResources</a> in the <i>Resource Groups Tagging API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet.Option"> <summary> <para> <para> Determines whether an application tag is applied or skipped. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet.Resource"> <summary> <para> <para>The name or ID of the resource of which the application will be associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet.ResourceType"> <summary> <para> <para>The type of resource of which the application will be associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.AssociateResourceResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.AssociateResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RegisterSCARResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARApplicationCmdlet"> <summary> Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARApplicationCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Application'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.DeleteApplicationResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.DeleteApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Application parameter. The -PassThru parameter is deprecated, use -Select '^Application' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARAttributeGroupCmdlet"> <summary> Deletes an attribute group, specified either by its attribute group ID, name, or ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARAttributeGroupCmdlet.AttributeGroup"> <summary> <para> <para> The name, ID, or ARN of the attribute group that holds the attributes to describe the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARAttributeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.DeleteAttributeGroupResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.DeleteAttributeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARAttributeGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttributeGroup parameter. The -PassThru parameter is deprecated, use -Select '^AttributeGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARAttributeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARResourceTagCmdlet"> <summary> Removes tags from a resource. <para> This operation returns an empty response if the call was successful. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon resource name (ARN) that specifies the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of the tag keys to remove from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.RemoveSCARResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.SyncSCARResourceCmdlet"> <summary> Syncs the resource with current AppRegistry records. <para> Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.SyncSCARResourceCmdlet.Resource"> <summary> <para> <para>An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.SyncSCARResourceCmdlet.ResourceType"> <summary> <para> <para>The type of resource of which the application will be associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.SyncSCARResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.SyncResourceResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.SyncResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.SyncSCARResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.SyncSCARResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARAttributeGroupCmdlet"> <summary> Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts <c>AssociateAttributeGroup</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARAttributeGroupCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARAttributeGroupCmdlet.AttributeGroup"> <summary> <para> <para> The name, ID, or ARN of the attribute group that holds the attributes to describe the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARAttributeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.DisassociateAttributeGroupResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.DisassociateAttributeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARAttributeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARResourceCmdlet"> <summary> Disassociates a resource from application. Both the resource and the application can be specified either by ID or name. <para><b>Minimum permissions</b></para><para> You must have the following permissions to remove a resource that's been associated with an application using the <c>APPLY_APPLICATION_TAG</c> option for <a href="https://docs.aws.amazon.com/servicecatalog/latest/dg/API_app-registry_AssociateResource.html">AssociateResource</a>. </para><ul><li><para><c>tag:GetResources</c></para></li><li><para><c>tag:UntagResources</c></para></li></ul><para> You must also have the following permissions if you don't use the <c>AWSServiceCatalogAppRegistryFullAccess</c> policy. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html">AWSServiceCatalogAppRegistryFullAccess</a> in the AppRegistry Administrator Guide. </para><ul><li><para><c>resource-groups:DisassociateResource</c></para></li><li><para><c>cloudformation:UpdateStack</c></para></li><li><para><c>cloudformation:DescribeStacks</c></para></li></ul><note><para> In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntTagResources.html">UntagResources</a> in the <i>Resource Groups Tagging API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARResourceCmdlet.Application"> <summary> <para> <para>The name or ID of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARResourceCmdlet.Resource"> <summary> <para> <para>The name or ID of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARResourceCmdlet.ResourceType"> <summary> <para> <para>The type of the resource that is being disassociated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.DisassociateResourceResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.DisassociateResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UnregisterSCARResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet"> <summary> Updates an existing application with new attributes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet.Application"> <summary> <para> <para> The name, ID, or ARN of the application that will be updated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet.Description"> <summary> <para> <para>The new description of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet.Name"> <summary> <para> <para>Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Application'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.UpdateApplicationResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.UpdateApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Application parameter. The -PassThru parameter is deprecated, use -Select '^Application' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet"> <summary> Updates an existing attribute group with new details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.AttributeGroup"> <summary> <para> <para> The name, ID, or ARN of the attribute group that holds the attributes to describe the application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.Attribute"> <summary> <para> <para>A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.Description"> <summary> <para> <para>The description of the attribute group that the user provides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.Name"> <summary> <para> <para>Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group. Please do not use this field as we have stopped supporting name updates.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.UpdateAttributeGroupResponse). Specifying the name of a property of type Amazon.AppRegistry.Model.UpdateAttributeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttributeGroup parameter. The -PassThru parameter is deprecated, use -Select '^AttributeGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.UpdateSCARAttributeGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCAR.WriteSCARConfigurationCmdlet"> <summary> Associates a <c>TagKey</c> configuration to an account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.WriteSCARConfigurationCmdlet.TagQueryConfiguration_TagKey"> <summary> <para> <para> Condition in the IAM policy that associates resources to an application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.WriteSCARConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRegistry.Model.PutConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.WriteSCARConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagQueryConfiguration_TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagQueryConfiguration_TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCAR.WriteSCARConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |